Class: Aws::SSM::Types::CreateAssociationRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::CreateAssociationRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
When making an API call, you may pass CreateAssociationRequest data as a hash:
{
name: "DocumentName", # required
document_version: "DocumentVersion",
instance_id: "InstanceId",
parameters: {
"ParameterName" => ["ParameterValue"],
},
targets: [
{
key: "TargetKey",
values: ["TargetValue"],
},
],
schedule_expression: "ScheduleExpression",
output_location: {
s3_location: {
output_s3_region: "S3Region",
output_s3_bucket_name: "S3BucketName",
output_s3_key_prefix: "S3KeyPrefix",
},
},
association_name: "AssociationName",
automation_target_parameter_name: "AutomationTargetParameterName",
max_errors: "MaxErrors",
max_concurrency: "MaxConcurrency",
compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
}
Instance Attribute Summary collapse
-
#association_name ⇒ String
Specify a descriptive name for the association.
-
#automation_target_parameter_name ⇒ String
Specify the target for the association.
-
#compliance_severity ⇒ String
The severity level to assign to the association.
-
#document_version ⇒ String
The document version you want to associate with the target(s).
-
#instance_id ⇒ String
The instance ID.
-
#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.
-
#parameters ⇒ Hash<String,Array<String>>
The parameters for the documents runtime configuration.
-
#schedule_expression ⇒ String
A cron expression when the association will be applied to the target(s).
-
#targets ⇒ Array<Types::Target>
The targets (either instances or tags) for the association.
Instance Attribute Details
#association_name ⇒ String
Specify a descriptive name for the association.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_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.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_name, :max_errors, :max_concurrency, :compliance_severity) include Aws::Structure end |
#compliance_severity ⇒ String
The severity level to assign to the association.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_name, :max_errors, :max_concurrency, :compliance_severity) include Aws::Structure end |
#document_version ⇒ String
The document version you want to associate with the target(s). Can be a specific version or the default version.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_name, :max_errors, :max_concurrency, :compliance_severity) include Aws::Structure end |
#instance_id ⇒ String
The instance ID.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_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.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_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.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_name, :max_errors, :max_concurrency, :compliance_severity) include Aws::Structure end |
#name ⇒ String
The name of the Systems Manager document.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_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.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_name, :max_errors, :max_concurrency, :compliance_severity) include Aws::Structure end |
#parameters ⇒ Hash<String,Array<String>>
The parameters for the documents runtime configuration.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_name, :max_errors, :max_concurrency, :compliance_severity) include Aws::Structure end |
#schedule_expression ⇒ String
A cron expression when the association will be applied to the target(s).
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_name, :max_errors, :max_concurrency, :compliance_severity) include Aws::Structure end |
#targets ⇒ Array<Types::Target>
The targets (either instances or tags) for the association.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/aws-sdk-ssm/types.rb', line 2348 class CreateAssociationRequest < Struct.new( :name, :document_version, :instance_id, :parameters, :targets, :schedule_expression, :output_location, :association_name, :automation_target_parameter_name, :max_errors, :max_concurrency, :compliance_severity) include Aws::Structure end |