You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#default_instance_nameString

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)


2184
2185
2186
2187
2188
2189
2190
2191
2192
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2184

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

#descriptionString

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)


2184
2185
2186
2187
2188
2189
2190
2191
2192
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2184

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

#expiration_dateTime

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

Returns:

  • (Time)


2184
2185
2186
2187
2188
2189
2190
2191
2192
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2184

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

#iam_roleString

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

Returns:

  • (String)


2184
2185
2186
2187
2188
2189
2190
2191
2192
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2184

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

#registration_limitInteger

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

Returns:

  • (Integer)


2184
2185
2186
2187
2188
2189
2190
2191
2192
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2184

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

#tagsArray<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:



2184
2185
2186
2187
2188
2189
2190
2191
2192
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2184

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