Class: Aws::SSM::Types::CreateActivationRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::CreateActivationRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass CreateActivationRequest data as a hash:

{
  description: "ActivationDescription",
  default_instance_name: "DefaultInstanceName",
  iam_role: "IamRole", # required
  registration_limit: 1,
  expiration_date: Time.now,
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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.

• #description ⇒ String

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

• #expiration_date ⇒ Time

  The date by which this activation request should expire.

• #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.

• #tags ⇒ Array<Types::Tag>

  Optional metadata that you assign to a resource.

Instance Attribute Details

#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.

Do not enter personally identifiable information in this field.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 2211

class CreateActivationRequest < Struct.new(
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :expiration_date,
  :tags)
  include Aws::Structure
end

#description ⇒ String

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

Do not enter personally identifiable information in this field.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 2211

class CreateActivationRequest < Struct.new(
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :expiration_date,
  :tags)
  include Aws::Structure
end

#expiration_date ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-ssm/types.rb', line 2211

class CreateActivationRequest < Struct.new(
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :expiration_date,
  :tags)
  include Aws::Structure
end

#iam_role ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 2211

class CreateActivationRequest < Struct.new(
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :expiration_date,
  :tags)
  include Aws::Structure
end

#registration_limit ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-ssm/types.rb', line 2211

class CreateActivationRequest < Struct.new(
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :expiration_date,
  :tags)
  include Aws::Structure
end

#tags ⇒ Array<Types::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 name/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 and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with “mi-”. For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-ssm/types.rb', line 2211

class CreateActivationRequest < Struct.new(
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :expiration_date,
  :tags)
  include Aws::Structure
end