Container for the parameters to the CreateActivation operation.
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 Using
Amazon Web Services Systems Manager in hybrid and multicloud 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.SimpleSystemsManagement.AmazonSimpleSystemsManagementRequest
Amazon.SimpleSystemsManagement.Model.CreateActivationRequest
Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z
Syntax
public class CreateActivationRequest : AmazonSimpleSystemsManagementRequest IAmazonWebServiceRequest
The CreateActivationRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateActivationRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
DefaultInstanceName | System.String |
Gets and sets the property 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. |
|
|
Description | System.String |
Gets and sets the property 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. |
|
|
ExpirationDate | System.DateTime |
Gets and sets the property ExpirationDate. The date by which this activation request should expire, in timestamp format, such as "2024-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. |
|
|
IamRole | System.String |
Gets and sets the property 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 You can't specify an IAM service-linked role for this parameter. You must create a unique role. |
|
|
RegistrationLimit | System.Int32 |
Gets and sets the property RegistrationLimit.
Specify the maximum number of managed nodes you want to register. The default value
is |
|
|
RegistrationMetadata | System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.RegistrationMetadataItem> |
Gets and sets the property RegistrationMetadata. Reserved for internal use. |
|
|
Tags | System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.Tag> |
Gets and sets the property Tags. 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:
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. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5