/*******************************************************************************
* 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.SimpleSystemsManagement;
using Amazon.SimpleSystemsManagement.Model;
namespace Amazon.PowerShell.Cmdlets.SSM
{
///
/// Generates an activation code and activation ID you can use to register your on-premises
/// servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager.
/// Registering these machines with Systems Manager makes it possible to manage them using
/// Systems Manager capabilities. You use the activation code and ID when installing SSM
/// Agent on machines in your hybrid environment. For more information about requirements
/// for managing on-premises machines using Systems Manager, see Setting
/// up Amazon Web Services Systems Manager for hybrid environments in the Amazon
/// Web Services Systems Manager User Guide.
///
///
/// Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises
/// servers and VMs that are configured for Systems Manager are all called managed
/// nodes.
///
///
[Cmdlet("New", "SSMActivation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.SimpleSystemsManagement.Model.CreateActivationResponse")]
[AWSCmdlet("Calls the AWS Systems Manager CreateActivation API operation.", Operation = new[] {"CreateActivation"}, SelectReturnType = typeof(Amazon.SimpleSystemsManagement.Model.CreateActivationResponse))]
[AWSCmdletOutput("Amazon.SimpleSystemsManagement.Model.CreateActivationResponse",
"This cmdlet returns an Amazon.SimpleSystemsManagement.Model.CreateActivationResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class NewSSMActivationCmdlet : AmazonSimpleSystemsManagementClientCmdlet, IExecutor
{
#region Parameter DefaultInstanceName
///
///
/// The name of the registered, managed node as it will appear in the Amazon Web Services
/// Systems Manager console or when you use the Amazon Web Services command line tools
/// to list Systems Manager resources.Don't enter personally identifiable information in this field.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DefaultInstanceName { get; set; }
#endregion
#region Parameter Description
///
///
/// A user-defined description of the resource that you want to register with Systems
/// Manager. Don't enter personally identifiable information in this field.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter ExpirationDate
///
///
/// The date by which this activation request should expire, in timestamp format, such
/// as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you
/// don't provide an expiration date, the activation code expires in 24 hours.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.DateTime? ExpirationDate { get; set; }
#endregion
#region Parameter IamRole
///
///
/// The name of the Identity and Access Management (IAM) role that you want to assign
/// to the managed node. This IAM role must provide AssumeRole permissions for the Amazon
/// Web Services Systems Manager service principal ssm.amazonaws.com
. For
/// more information, see Create
/// an IAM service role for a hybrid environment in the Amazon Web Services Systems
/// Manager User Guide.You can't specify an IAM service-linked role for this parameter. You must create a
/// unique role.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String IamRole { get; set; }
#endregion
#region Parameter RegistrationLimit
///
///
/// Specify the maximum number of managed nodes you want to register. The default value
/// is 1
.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? RegistrationLimit { get; set; }
#endregion
#region Parameter RegistrationMetadata
///
///
/// Reserved for internal use.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public Amazon.SimpleSystemsManagement.Model.RegistrationMetadataItem[] RegistrationMetadata { get; set; }
#endregion
#region Parameter Tag
///
///
/// Optional metadata that you assign to a resource. Tags enable you to categorize a resource
/// in different ways, such as by purpose, owner, or environment. For example, you might
/// want to tag an activation to identify which servers or virtual machines (VMs) in your
/// on-premises environment you intend to activate. In this case, you could specify the
/// following key-value pairs:Key=OS,Value=Windows
Key=Environment,Value=Production
When you install SSM Agent on your on-premises servers and VMs, you specify an activation
/// ID and code. When you specify the activation ID and code, tags assigned to the activation
/// are automatically applied to the on-premises servers or VMs.You can't add tags to or delete tags from an existing activation. You can tag your
/// on-premises servers, edge devices, and VMs after they connect to Systems Manager for
/// the first time and are assigned a managed node ID. This means they are listed in the
/// Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-".
/// For information about how to add tags to your managed nodes, see AddTagsToResource.
/// For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public Amazon.SimpleSystemsManagement.Model.Tag[] Tag { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CreateActivationResponse).
/// Specifying the name of a property of type Amazon.SimpleSystemsManagement.Model.CreateActivationResponse 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; } = "*";
#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.DefaultInstanceName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-SSMActivation (CreateActivation)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.DefaultInstanceName = this.DefaultInstanceName;
context.Description = this.Description;
context.ExpirationDate = this.ExpirationDate;
context.IamRole = this.IamRole;
#if MODULAR
if (this.IamRole == null && ParameterWasBound(nameof(this.IamRole)))
{
WriteWarning("You are passing $null as a value for parameter IamRole 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
context.RegistrationLimit = this.RegistrationLimit;
if (this.RegistrationMetadata != null)
{
context.RegistrationMetadata = new List(this.RegistrationMetadata);
}
if (this.Tag != null)
{
context.Tag = new List(this.Tag);
}
// 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.SimpleSystemsManagement.Model.CreateActivationRequest();
if (cmdletContext.DefaultInstanceName != null)
{
request.DefaultInstanceName = cmdletContext.DefaultInstanceName;
}
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.ExpirationDate != null)
{
request.ExpirationDate = cmdletContext.ExpirationDate.Value;
}
if (cmdletContext.IamRole != null)
{
request.IamRole = cmdletContext.IamRole;
}
if (cmdletContext.RegistrationLimit != null)
{
request.RegistrationLimit = cmdletContext.RegistrationLimit.Value;
}
if (cmdletContext.RegistrationMetadata != null)
{
request.RegistrationMetadata = cmdletContext.RegistrationMetadata;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.SimpleSystemsManagement.Model.CreateActivationResponse CallAWSServiceOperation(IAmazonSimpleSystemsManagement client, Amazon.SimpleSystemsManagement.Model.CreateActivationRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Systems Manager", "CreateActivation");
try
{
#if DESKTOP
return client.CreateActivation(request);
#elif CORECLR
return client.CreateActivationAsync(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 DefaultInstanceName { get; set; }
public System.String Description { get; set; }
public System.DateTime? ExpirationDate { get; set; }
public System.String IamRole { get; set; }
public System.Int32? RegistrationLimit { get; set; }
public List RegistrationMetadata { get; set; }
public List Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}