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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Describes the parameters for a document.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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

  Specify the target for the association.

• #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.

• #instance_id ⇒ String

  The ID of the instance.

• #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 Systems Manager 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.

• #status ⇒ Types::AssociationStatus

  The association status.

• #sync_compliance ⇒ String

  The mode for generating association compliance.

• #targets ⇒ Array<Types::Target>

  The instances targeted by the request.

Instance Attribute Details

#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.

Returns:

• (Boolean)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#association_id ⇒ String

The association ID.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#association_name ⇒ String

The association name.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#association_version ⇒ String

The association version.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#automation_target_parameter_name ⇒ String

Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_severity ⇒ String

The severity level that is assigned to the association.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#date ⇒ Time

The date when the association was made.

Returns:

• (Time)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#document_version ⇒ String

The document version.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The ID of the instance.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_execution_date ⇒ Time

The date on which the association was last run.

Returns:

• (Time)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_successful_execution_date ⇒ Time

The last date on which the association was successfully run.

Returns:

• (Time)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_update_association_date ⇒ Time

The date when the association was last updated.

Returns:

• (Time)

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

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)
  SENSITIVE = []
  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 instance 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 instance will process its association within the limit specified for MaxConcurrency.

Returns:

• (String)

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

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)
  SENSITIVE = []
  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 instances 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 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 392

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)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the Systems Manager document.

Returns:

• (String)

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

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)
  SENSITIVE = []
  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 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 392

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)
  SENSITIVE = []
  include Aws::Structure
end

#overview ⇒ Types::AssociationOverview

Information about the association.

Returns:

• (Types::AssociationOverview)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

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

A description of the parameters for a document.

Returns:

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

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ String

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

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Types::AssociationStatus

The association status.

Returns:

• (Types::AssociationStatus)

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

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)
  SENSITIVE = []
  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 action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.

By default, all associations use AUTO mode.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#targets ⇒ Array<Types::Target>

The instances targeted by the request.

Returns:

• (Array<Types::Target>)

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

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)
  SENSITIVE = []
  include Aws::Structure
end