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

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#association_idString

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)


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_nameString

The association name.

Returns:

  • (String)


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_versionString

The association version.

Returns:

  • (String)


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_versionString

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)


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

#durationInteger

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.

Returns:

  • (Integer)


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_idString

The managed node ID.

Returns:

  • (String)


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_dateTime

The date on which the association was last run.

Returns:

  • (Time)


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

#nameString

The name of the SSM document.

Returns:

  • (String)


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

#overviewTypes::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_expressionString

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

Returns:

  • (String)


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_offsetInteger

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

Returns:

  • (Integer)


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_mapsArray<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>>>)


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

#targetsArray<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:



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