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

Class: Aws::SSM::Types::Activation

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.

Instance Attribute Summary collapse

Instance Attribute Details

#activation_idString

The ID created by Systems Manager when you submitted the activation.

Returns:

  • (String)


58
59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 58

class Activation < Struct.new(
  :activation_id,
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :registrations_count,
  :expiration_date,
  :expired,
  :created_date)
  include Aws::Structure
end

#created_dateTime

The date the activation was created.

Returns:

  • (Time)


58
59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 58

class Activation < Struct.new(
  :activation_id,
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :registrations_count,
  :expiration_date,
  :expired,
  :created_date)
  include Aws::Structure
end

#default_instance_nameString

A name for the managed instance when it is created.

Returns:

  • (String)


58
59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 58

class Activation < Struct.new(
  :activation_id,
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :registrations_count,
  :expiration_date,
  :expired,
  :created_date)
  include Aws::Structure
end

#descriptionString

A user defined description of the activation.

Returns:

  • (String)


58
59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 58

class Activation < Struct.new(
  :activation_id,
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :registrations_count,
  :expiration_date,
  :expired,
  :created_date)
  include Aws::Structure
end

#expiration_dateTime

The date when this activation can no longer be used to register managed instances.

Returns:

  • (Time)


58
59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 58

class Activation < Struct.new(
  :activation_id,
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :registrations_count,
  :expiration_date,
  :expired,
  :created_date)
  include Aws::Structure
end

#expiredBoolean

Whether or not the activation is expired.

Returns:

  • (Boolean)


58
59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 58

class Activation < Struct.new(
  :activation_id,
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :registrations_count,
  :expiration_date,
  :expired,
  :created_date)
  include Aws::Structure
end

#iam_roleString

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

Returns:

  • (String)


58
59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 58

class Activation < Struct.new(
  :activation_id,
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :registrations_count,
  :expiration_date,
  :expired,
  :created_date)
  include Aws::Structure
end

#registration_limitInteger

The maximum number of managed instances that can be registered using this activation.

Returns:

  • (Integer)


58
59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 58

class Activation < Struct.new(
  :activation_id,
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :registrations_count,
  :expiration_date,
  :expired,
  :created_date)
  include Aws::Structure
end

#registrations_countInteger

The number of managed instances already registered with this activation.

Returns:

  • (Integer)


58
59
60
61
62
63
64
65
66
67
68
69
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 58

class Activation < Struct.new(
  :activation_id,
  :description,
  :default_instance_name,
  :iam_role,
  :registration_limit,
  :registrations_count,
  :expiration_date,
  :expired,
  :created_date)
  include Aws::Structure
end