Class: Aws::SSM::Types::AssociationDescription

Inherits:

Struct

Object
Struct
Aws::SSM::Types::AssociationDescription

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-ssm/types.rb

Overview

Describes the parameters for a document.

Constant Summary collapse

SENSITIVE =

[:parameters]

Instance Attribute Summary collapse

#alarm_configuration ⇒ Types::AlarmConfiguration

The details for the CloudWatch alarm you want to apply to an automation or command.
#apply_only_at_cron_interval ⇒ Boolean

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified.
#association_id ⇒ String

The association ID.
#association_name ⇒ String

The association name.
#association_version ⇒ String

The association version.
#automation_target_parameter_name ⇒ String

Choose the parameter that will define how your automation will branch out.
#calendar_names ⇒ Array<String>

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
#compliance_severity ⇒ String

The severity level that is assigned to the association.
#date ⇒ Time

The date when the association was made.
#document_version ⇒ String

The document version.
#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.
#last_successful_execution_date ⇒ Time

The last date on which the association was successfully run.
#last_update_association_date ⇒ Time

The date when the association was last updated.
#max_concurrency ⇒ String

The maximum number of targets allowed to run the association at the same time.
#max_errors ⇒ String

The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
#name ⇒ String

The name of the SSM document.
#output_location ⇒ Types::InstanceAssociationOutputLocation

An S3 bucket where you want to store the output details of the request.
#overview ⇒ Types::AssociationOverview

Information about the association.
#parameters ⇒ Hash<String,Array<String>>

A description of the parameters for a document.
#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.
#status ⇒ Types::AssociationStatus

The association status.
#sync_compliance ⇒ String

The mode for generating association compliance.
#target_locations ⇒ Array<Types::TargetLocation>

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the 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.
#triggered_alarms ⇒ Array<Types::AlarmStateInformation>

The CloudWatch alarm that was invoked during the association.

Instance Attribute Details

#alarm_configuration ⇒ `Types::AlarmConfiguration`

The details for the CloudWatch alarm you want to apply to an automation or command.

Returns:

(Types::AlarmConfiguration)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#apply_only_at_cron_interval ⇒ `Boolean`

By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don’t want an association to run immediately after you create it. This parameter isn’t supported for rate expressions.

Returns:

(Boolean)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#association_id ⇒ `String`

The association ID.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#association_name ⇒ `String`

The association name.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#association_version ⇒ `String`

The association version.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#automation_target_parameter_name ⇒ `String`

Choose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#calendar_names ⇒ `Array<String>`

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see [Amazon Web Services Systems Manager Change Calendar].

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar

Returns:

(Array<String>)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#compliance_severity ⇒ `String`

The severity level that is assigned to the association.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#date ⇒ `Time`

The date when the association was made.

Returns:

(Time)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#document_version ⇒ `String`

The document version.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  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.

Returns:

(Integer)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#instance_id ⇒ `String`

The managed node ID.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  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 572

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#last_successful_execution_date ⇒ `Time`

The last date on which the association was successfully run.

Returns:

(Time)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#last_update_association_date ⇒ `Time`

The date when the association was last updated.

Returns:

(Time)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#max_concurrency ⇒ `String`

The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

If a new managed node starts and attempts to run an association while Systems Manager is running ‘MaxConcurrency` associations, the association is allowed to run. During the next association interval, the new managed node will process its association within the limit specified for `MaxConcurrency`.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#max_errors ⇒ `String`

The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 managed nodes and set ‘MaxError` to 10%, then the system stops sending the request when the sixth error is received.

Executions that are already running an association when ‘MaxErrors` is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won’t be more than max-errors failed executions, set ‘MaxConcurrency` to 1 so that executions proceed one at a time.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#name ⇒ `String`

The name of the SSM document.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#output_location ⇒ `Types::InstanceAssociationOutputLocation`

An S3 bucket where you want to store the output details of the request.

Returns:

(Types::InstanceAssociationOutputLocation)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#overview ⇒ `Types::AssociationOverview`

Information about the association.

Returns:

(Types::AssociationOverview)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#parameters ⇒ `Hash<String,Array<String>>`

A description of the parameters for a document.

Returns:

(Hash<String,Array<String>>)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#schedule_expression ⇒ `String`

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

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  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 572

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#status ⇒ `Types::AssociationStatus`

The association status.

Returns:

(Types::AssociationStatus)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#sync_compliance ⇒ `String`

The mode for generating association compliance. You can specify ‘AUTO` or `MANUAL`. In `AUTO` mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is `COMPLIANT`. If the association execution doesn’t run successfully, the association is ‘NON-COMPLIANT`.

In ‘MANUAL` mode, you must specify the `AssociationId` as a parameter for the PutComplianceItems API operation. In this case, compliance data isn’t managed by State Manager, a capability of Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use ‘AUTO` mode.

Returns:

(String)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#target_locations ⇒ `Array<Types::TargetLocation>`

The combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.

Returns:

(Array<Types::TargetLocation>)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  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 572

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#targets ⇒ `Array<Types::Target>`

The managed nodes targeted by the request.

Returns:

(Array<Types::Target>)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#triggered_alarms ⇒ `Array<Types::AlarmStateInformation>`

The CloudWatch alarm that was invoked during the association.

Returns:

(Array<Types::AlarmStateInformation>)

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

class AssociationDescription < Struct.new(
  :name,
  :instance_id,
  :association_version,
  :date,
  :last_update_association_date,
  :status,
  :overview,
  :document_version,
  :automation_target_parameter_name,
  :parameters,
  :association_id,
  :targets,
  :schedule_expression,
  :output_location,
  :last_execution_date,
  :last_successful_execution_date,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :alarm_configuration,
  :triggered_alarms)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

Class: Aws::SSM::Types::AssociationDescription

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configuration ⇒ Types::AlarmConfiguration

#apply_only_at_cron_interval ⇒ Boolean

#association_id ⇒ String

#association_name ⇒ String

#association_version ⇒ String

#automation_target_parameter_name ⇒ String

#calendar_names ⇒ Array<String>

#compliance_severity ⇒ String

#date ⇒ Time

#document_version ⇒ String

#duration ⇒ Integer

#instance_id ⇒ String

#last_execution_date ⇒ Time

#last_successful_execution_date ⇒ Time

#last_update_association_date ⇒ Time

#max_concurrency ⇒ String

#max_errors ⇒ String

#name ⇒ String

#output_location ⇒ Types::InstanceAssociationOutputLocation

#overview ⇒ Types::AssociationOverview

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

#schedule_expression ⇒ String

#schedule_offset ⇒ Integer

#status ⇒ Types::AssociationStatus

#sync_compliance ⇒ String

#target_locations ⇒ Array<Types::TargetLocation>

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

#targets ⇒ Array<Types::Target>

#triggered_alarms ⇒ Array<Types::AlarmStateInformation>

#alarm_configuration ⇒ `Types::AlarmConfiguration`

#apply_only_at_cron_interval ⇒ `Boolean`

#association_id ⇒ `String`

#association_name ⇒ `String`

#association_version ⇒ `String`

#automation_target_parameter_name ⇒ `String`

#calendar_names ⇒ `Array<String>`

#compliance_severity ⇒ `String`

#date ⇒ `Time`

#document_version ⇒ `String`

#duration ⇒ `Integer`

#instance_id ⇒ `String`

#last_execution_date ⇒ `Time`

#last_successful_execution_date ⇒ `Time`

#last_update_association_date ⇒ `Time`

#max_concurrency ⇒ `String`

#max_errors ⇒ `String`

#name ⇒ `String`

#output_location ⇒ `Types::InstanceAssociationOutputLocation`

#overview ⇒ `Types::AssociationOverview`

#parameters ⇒ `Hash<String,Array<String>>`

#schedule_expression ⇒ `String`

#schedule_offset ⇒ `Integer`

#status ⇒ `Types::AssociationStatus`

#sync_compliance ⇒ `String`

#target_locations ⇒ `Array<Types::TargetLocation>`

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

#targets ⇒ `Array<Types::Target>`

#triggered_alarms ⇒ `Array<Types::AlarmStateInformation>`