Class: Aws::SSM::Types::Association

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::Association

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #association_id ⇒ String

  The ID created by the system when you create an association.

• #association_name ⇒ String

  The association name.

• #association_version ⇒ String

  The association version.

• #document_version ⇒ String

  The version of the document used in the association.

• #instance_id ⇒ String

  The managed node ID.

• #last_execution_date ⇒ Time

  The date on which the association was last run.

• #name ⇒ String

  The name of the SSM document.

• #overview ⇒ Types::AssociationOverview

  Information about the association.

• #schedule_expression ⇒ String

  A cron expression that specifies a schedule when the association runs.

• #schedule_offset ⇒ Integer

  Number of days to wait after the scheduled day to run an association.

• #target_maps ⇒ Array<Hash<String,Array<String>>>

  A key-value mapping of document parameters to target resources.

• #targets ⇒ Array<Types::Target>

  The managed nodes targeted by the request to create an association.

Instance Attribute Details

#association_id ⇒ String

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

Returns:

• (String)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#association_name ⇒ String

The association name.

Returns:

• (String)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#association_version ⇒ String

The association version.

Returns:

• (String)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#document_version ⇒ String

The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the ‘apply-only-at-cron-interval` parameter.

State Manager doesn’t support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the ‘default` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to `default`.

Returns:

• (String)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The managed node ID.

Returns:

• (String)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#last_execution_date ⇒ Time

The date on which the association was last run.

Returns:

• (Time)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the SSM document.

Returns:

• (String)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#overview ⇒ Types::AssociationOverview

Information about the association.

Returns:

• (Types::AssociationOverview)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ String

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

Returns:

• (String)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_offset ⇒ Integer

Number of days to wait after the scheduled day to run an association.

Returns:

• (Integer)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#target_maps ⇒ Array<Hash<String,Array<String>>>

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can’t be specified together.

Returns:

• (Array<Hash<String,Array<String>>>)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end

#targets ⇒ Array<Types::Target>

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the ‘InstanceIds` key with a value of `*`.

Returns:

• (Array<Types::Target>)

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

class Association < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version,
  :document_version,
  :targets,
  :last_execution_date,
  :overview,
  :schedule_expression,
  :association_name,
  :schedule_offset,
  :target_maps)
  SENSITIVE = []
  include Aws::Structure
end