Class: Aws::SSM::Types::CreateAssociationBatchRequestEntry

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass CreateAssociationBatchRequestEntry data as a hash:

{
  name: "DocumentARN", # required
  instance_id: "InstanceId",
  parameters: {
    "ParameterName" => ["ParameterValue"],
  },
  automation_target_parameter_name: "AutomationTargetParameterName",
  document_version: "DocumentVersion",
  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",
  max_errors: "MaxErrors",
  max_concurrency: "MaxConcurrency",
  compliance_severity: "CRITICAL", # accepts CRITICAL, HIGH, MEDIUM, LOW, UNSPECIFIED
  sync_compliance: "AUTO", # accepts AUTO, MANUAL
  apply_only_at_cron_interval: false,
  calendar_names: ["CalendarNameOrARN"],
  target_locations: [
    {
      accounts: ["Account"],
      regions: ["Region"],
      target_location_max_concurrency: "MaxConcurrency",
      target_location_max_errors: "MaxErrors",
      execution_role_name: "ExecutionRoleName",
    },
  ],
  schedule_offset: 1,
  target_maps: [
    {
      "TargetMapKey" => ["TargetMapValue"],
    },
  ],
  alarm_configuration: {
    ignore_poll_alarm_failure: false,
    alarms: [ # required
      {
        name: "AlarmName", # required
      },
    ],
  },
}

Describes the association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

Constant Summary collapse

SENSITIVE =
[:parameters]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configurationTypes::AlarmConfiguration

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


3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#apply_only_at_cron_intervalBoolean

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)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#association_nameString

Specify a descriptive name for the association.

Returns:

  • (String)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#automation_target_parameter_nameString

Specify the target for the association. 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)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#calendar_namesArray<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>)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#compliance_severityString

The severity level to assign to the association.

Returns:

  • (String)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#document_versionString

The document version.

Returns:

  • (String)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#instance_idString

The managed node ID.

<note markdown=“1”> `InstanceId` has been deprecated. To specify a managed node ID for an association, use the `Targets` parameter. Requests that include the parameter `InstanceID` with Systems Manager documents (SSM documents) that use schema version 2.0 or later will fail. In addition, if you use the parameter `InstanceId`, you can't use the parameters `AssociationName`, `DocumentVersion`, `MaxErrors`, `MaxConcurrency`, `OutputLocation`, or `ScheduleExpression`. To use these parameters, you must use the `Targets` parameter.

</note>

Returns:

  • (String)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#max_concurrencyString

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)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#max_errorsString

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)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#nameString

The name of the SSM document that contains the configuration information for the managed node. You can specify Command or Automation runbooks.

You can specify Amazon Web Services-predefined documents, documents you created, or a document that is shared with you from another account.

For SSM documents that are shared with you from other Amazon Web Services accounts, you must specify the complete SSM document ARN, in the following format:

`arn:aws:ssm:region:account-id:document/document-name `

For example:

`arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document`

For Amazon Web Services-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, `AWS-ApplyPatchBaseline` or `My-Document`.

Returns:

  • (String)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#output_locationTypes::InstanceAssociationOutputLocation

An S3 bucket where you want to store the results of this request.


3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#parametersHash<String,Array<String>>

A description of the parameters for a document.

Returns:

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

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#schedule_expressionString

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

Returns:

  • (String)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#schedule_offsetInteger

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

Returns:

  • (Integer)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#sync_complianceString

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)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#target_locationsArray<Types::TargetLocation>

Use this action to create an association in multiple Regions and multiple accounts.

Returns:


3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  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>>>)

3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#targetsArray<Types::Target>

The managed nodes targeted by the request.

Returns:


3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
# File 'lib/aws-sdk-ssm/types.rb', line 3285

class CreateAssociationBatchRequestEntry < Struct.new(
  :name,
  :instance_id,
  :parameters,
  :automation_target_parameter_name,
  :document_version,
  :targets,
  :schedule_expression,
  :output_location,
  :association_name,
  :max_errors,
  :max_concurrency,
  :compliance_severity,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end