/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.OpsWorks;
using Amazon.OpsWorks.Model;
namespace Amazon.PowerShell.Cmdlets.OPS
{
///
/// Registers instances that were created outside of AWS OpsWorks Stacks with a specified
/// stack.
///
///
/// We do not recommend using this action to register instances. The complete registration
/// operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance,
/// and registering the instance with the stack. RegisterInstance handles
/// only the second step. You should instead use the AWS CLI register command,
/// which performs the entire registration operation. For more information, see
/// Registering an Instance with an AWS OpsWorks Stacks Stack.
///
/// Registered instances have the same requirements as instances that are created by using
/// the CreateInstance API. For example, registered instances must be running a
/// supported Linux-based operating system, and they must have a supported instance type.
/// For more information about requirements for instances that you want to register, see
///
/// Preparing the Instance.
/// Required Permissions: To use this action, an IAM user must have a Manage permissions
/// level for the stack or an attached policy that explicitly grants permissions. For
/// more information on user permissions, see Managing
/// User Permissions.
///
///
[Cmdlet("Register", "OPSInstance", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS OpsWorks RegisterInstance API operation.", Operation = new[] {"RegisterInstance"}, SelectReturnType = typeof(Amazon.OpsWorks.Model.RegisterInstanceResponse))]
[AWSCmdletOutput("System.String or Amazon.OpsWorks.Model.RegisterInstanceResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.OpsWorks.Model.RegisterInstanceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RegisterOPSInstanceCmdlet : AmazonOpsWorksClientCmdlet, IExecutor
{
#region Parameter InstanceIdentity_Document
///
///
/// A JSON document that contains the metadata.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String InstanceIdentity_Document { get; set; }
#endregion
#region Parameter Hostname
///
///
/// The instance's hostname.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Hostname { get; set; }
#endregion
#region Parameter PrivateIp
///
///
/// The instance's private IP address.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PrivateIp { get; set; }
#endregion
#region Parameter PublicIp
///
///
/// The instance's public IP address.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String PublicIp { get; set; }
#endregion
#region Parameter RsaPublicKey
///
///
/// The instances public RSA key. This key is used to encrypt communication between the
/// instance and the service.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RsaPublicKey { get; set; }
#endregion
#region Parameter RsaPublicKeyFingerprint
///
///
/// The instances public RSA key fingerprint.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RsaPublicKeyFingerprint { get; set; }
#endregion
#region Parameter InstanceIdentity_Signature
///
///
/// A signature that can be used to verify the document's accuracy and authenticity.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String InstanceIdentity_Signature { get; set; }
#endregion
#region Parameter StackId
///
///
/// The ID of the stack that the instance is to be registered with.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String StackId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'InstanceId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OpsWorks.Model.RegisterInstanceResponse).
/// Specifying the name of a property of type Amazon.OpsWorks.Model.RegisterInstanceResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "InstanceId";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the StackId parameter.
/// The -PassThru parameter is deprecated, use -Select '^StackId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^StackId' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.StackId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Register-OPSInstance (RegisterInstance)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.StackId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Hostname = this.Hostname;
context.InstanceIdentity_Document = this.InstanceIdentity_Document;
context.InstanceIdentity_Signature = this.InstanceIdentity_Signature;
context.PrivateIp = this.PrivateIp;
context.PublicIp = this.PublicIp;
context.RsaPublicKey = this.RsaPublicKey;
context.RsaPublicKeyFingerprint = this.RsaPublicKeyFingerprint;
context.StackId = this.StackId;
#if MODULAR
if (this.StackId == null && ParameterWasBound(nameof(this.StackId)))
{
WriteWarning("You are passing $null as a value for parameter StackId which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.OpsWorks.Model.RegisterInstanceRequest();
if (cmdletContext.Hostname != null)
{
request.Hostname = cmdletContext.Hostname;
}
// populate InstanceIdentity
var requestInstanceIdentityIsNull = true;
request.InstanceIdentity = new Amazon.OpsWorks.Model.InstanceIdentity();
System.String requestInstanceIdentity_instanceIdentity_Document = null;
if (cmdletContext.InstanceIdentity_Document != null)
{
requestInstanceIdentity_instanceIdentity_Document = cmdletContext.InstanceIdentity_Document;
}
if (requestInstanceIdentity_instanceIdentity_Document != null)
{
request.InstanceIdentity.Document = requestInstanceIdentity_instanceIdentity_Document;
requestInstanceIdentityIsNull = false;
}
System.String requestInstanceIdentity_instanceIdentity_Signature = null;
if (cmdletContext.InstanceIdentity_Signature != null)
{
requestInstanceIdentity_instanceIdentity_Signature = cmdletContext.InstanceIdentity_Signature;
}
if (requestInstanceIdentity_instanceIdentity_Signature != null)
{
request.InstanceIdentity.Signature = requestInstanceIdentity_instanceIdentity_Signature;
requestInstanceIdentityIsNull = false;
}
// determine if request.InstanceIdentity should be set to null
if (requestInstanceIdentityIsNull)
{
request.InstanceIdentity = null;
}
if (cmdletContext.PrivateIp != null)
{
request.PrivateIp = cmdletContext.PrivateIp;
}
if (cmdletContext.PublicIp != null)
{
request.PublicIp = cmdletContext.PublicIp;
}
if (cmdletContext.RsaPublicKey != null)
{
request.RsaPublicKey = cmdletContext.RsaPublicKey;
}
if (cmdletContext.RsaPublicKeyFingerprint != null)
{
request.RsaPublicKeyFingerprint = cmdletContext.RsaPublicKeyFingerprint;
}
if (cmdletContext.StackId != null)
{
request.StackId = cmdletContext.StackId;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.OpsWorks.Model.RegisterInstanceResponse CallAWSServiceOperation(IAmazonOpsWorks client, Amazon.OpsWorks.Model.RegisterInstanceRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS OpsWorks", "RegisterInstance");
try
{
#if DESKTOP
return client.RegisterInstance(request);
#elif CORECLR
return client.RegisterInstanceAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.String Hostname { get; set; }
public System.String InstanceIdentity_Document { get; set; }
public System.String InstanceIdentity_Signature { get; set; }
public System.String PrivateIp { get; set; }
public System.String PublicIp { get; set; }
public System.String RsaPublicKey { get; set; }
public System.String RsaPublicKeyFingerprint { get; set; }
public System.String StackId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.InstanceId;
}
}
}