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,
}

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.

Returns:

  • (String)


1509
1510
1511
1512
1513
1514
1515
1516
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1509

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

#descriptionString

A userdefined description of the resource that you want to register with Amazon EC2.

Returns:

  • (String)


1509
1510
1511
1512
1513
1514
1515
1516
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1509

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

#expiration_dateTime

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

Returns:

  • (Time)


1509
1510
1511
1512
1513
1514
1515
1516
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1509

class CreateActivationRequest < Struct.new(
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :expiration_date)
  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)


1509
1510
1511
1512
1513
1514
1515
1516
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1509

class CreateActivationRequest < Struct.new(
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :expiration_date)
  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)


1509
1510
1511
1512
1513
1514
1515
1516
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 1509

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