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

Inherits:
Struct
  • Object
show all
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
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_instance_nameString

The name of the registered, managed instance 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.

Returns:

  • (String)

2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
# File 'lib/aws-sdk-ssm/types.rb', line 2716

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

#descriptionString

A user-defined description of the resource that you want to register with Systems Manager.

Don't enter personally identifiable information in this field.

Returns:

  • (String)

2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
# File 'lib/aws-sdk-ssm/types.rb', line 2716

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

#expiration_dateTime

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.

Returns:

  • (Time)

2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
# File 'lib/aws-sdk-ssm/types.rb', line 2716

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

#iam_roleString

The name of the Identity and Access Management (IAM) role that you want to assign to the managed instance. 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][1

in the

*Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/sysman-service-role.html

Returns:

  • (String)

2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
# File 'lib/aws-sdk-ssm/types.rb', line 2716

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

#registration_limitInteger

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

Returns:

  • (Integer)

2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
# File 'lib/aws-sdk-ssm/types.rb', line 2716

class CreateActivationRequest < Struct.new(
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :expiration_date,
  :tags)
  SENSITIVE = []
  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-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 Amazon Web Services 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:


2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
# File 'lib/aws-sdk-ssm/types.rb', line 2716

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