Class: Aws::SSM::Types::Association
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::Association
- Defined in:
- gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb
Overview
Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
-
#duration ⇒ Integer
The number of hours that an association can run on specified targets.
-
#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.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :target_maps) SENSITIVE = [] include Aws::Structure end |
#association_name ⇒ String
The association name.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :target_maps) SENSITIVE = [] include Aws::Structure end |
#association_version ⇒ String
The association version.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :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
.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :target_maps) SENSITIVE = [] include Aws::Structure end |
#duration ⇒ Integer
The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :target_maps) SENSITIVE = [] include Aws::Structure end |
#instance_id ⇒ String
The managed node ID.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :target_maps) SENSITIVE = [] include Aws::Structure end |
#last_execution_date ⇒ Time
The date on which the association was last run.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :target_maps) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the SSM document.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :target_maps) SENSITIVE = [] include Aws::Structure end |
#overview ⇒ Types::AssociationOverview
Information about the association.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :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).
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :target_maps) SENSITIVE = [] include Aws::Structure end |
#schedule_offset ⇒ Integer
Number of days to wait after the scheduled day to run an association.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :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.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :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 *
.
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 369 class Association < Struct.new( :name, :instance_id, :association_id, :association_version, :document_version, :targets, :last_execution_date, :overview, :schedule_expression, :association_name, :schedule_offset, :duration, :target_maps) SENSITIVE = [] include Aws::Structure end |