Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ssm ]

create-activation

Description

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-activation
[--description <value>]
[--default-instance-name <value>]
--iam-role <value>
[--registration-limit <value>]
[--expiration-date <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--description (string)

A user-defined description of the resource that you want to register with Amazon EC2.

Warning

Do not enter personally identifiable information in this field.

--default-instance-name (string)

The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.

Warning

Do not enter personally identifiable information in this field.

--iam-role (string)

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.

--registration-limit (integer)

Specify the maximum number of managed instances you want to register. The default value is 1 instance.

--expiration-date (timestamp)

The date by which this activation request should expire. The default value is 24 hours.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create an activation

This example creates a managed instance.

Command:

aws ssm create-activation --default-instance-name "MyWebServers" --iam-role "AutomationRole" --registration-limit 10

Output:

{
  "ActivationCode": "Zqr175DJ+sPQRHsmbzzf",
  "ActivationId": "5b9e0074-65d3-4587-8620-3e0b0938db9e"
}

Output

ActivationId -> (string)

The ID number generated by the system when it processed the activation. The activation ID functions like a user name.

ActivationCode -> (string)

The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.