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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_instance_name ⇒ String

  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.

• #description ⇒ String

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

• #expiration_date ⇒ Time

  The date by which this activation request should expire, in timestamp format, such as “2021-07-07T00:00:00”.

• #iam_role ⇒ String

  The name of the Identity and Access Management (IAM) role that you want to assign to the managed node.

• #registration_limit ⇒ Integer

  Specify the maximum number of managed nodes you want to register.

• #registration_metadata ⇒ Array<Types::RegistrationMetadataItem>

  Reserved for internal use.

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

Returns:

• (String)

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

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

#description ⇒ String

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)

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

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

#expiration_date ⇒ Time

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)

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

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

#iam_role ⇒ String

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 ‘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*.

<note markdown=“1”> You can’t specify an IAM service-linked role for this parameter. You must create a unique role.

</note>

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

Returns:

• (String)

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

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

#registration_limit ⇒ Integer

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

Returns:

• (Integer)

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

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

#registration_metadata ⇒ Array<Types::RegistrationMetadataItem>

Reserved for internal use.

Returns:

• (Array<Types::RegistrationMetadataItem>)

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

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

Returns:

• (Array<Types::Tag>)

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

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