Class: Aws::SSM::Types::AssociationDescription
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::AssociationDescription
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
Describes the parameters for a document.
Instance Attribute Summary collapse
-
#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 Amazon 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.
-
#targets ⇒ Array<Types::Target>
The instances targeted by the request.
Instance Attribute Details
#association_id ⇒ String
The association ID.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#association_name ⇒ String
The association name.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#association_version ⇒ String
The association version.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) 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.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#compliance_severity ⇒ String
The severity level that is assigned to the association.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#date ⇒ Time
The date when the association was made.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#document_version ⇒ String
The document version.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#instance_id ⇒ String
The ID of the instance.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#last_execution_date ⇒ Time
The date on which the association was last run.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#last_successful_execution_date ⇒ Time
The last date on which the association was successfully run.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#last_update_association_date ⇒ Time
The date when the association was last updated.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) 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 execute an association while Systems Manager is executing 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.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) 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.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#name ⇒ String
The name of the Systems Manager document.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#output_location ⇒ Types::InstanceAssociationOutputLocation
An Amazon S3 bucket where you want to store the output details of the request.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#overview ⇒ Types::AssociationOverview
Information about the association.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#parameters ⇒ Hash<String,Array<String>>
A description of the parameters for a document.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#schedule_expression ⇒ String
A cron expression that specifies a schedule when the association runs.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#status ⇒ Types::AssociationStatus
The association status.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |
#targets ⇒ Array<Types::Target>
The instances targeted by the request.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/aws-sdk-ssm/types.rb', line 311 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) include Aws::Structure end |