Class: Aws::SSM::Types::CreateAssociationRequest

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

Overview

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.



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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#apply_only_at_cron_intervalBoolean

By default, when you create a new association, 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)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#association_nameString

Specify a descriptive name for the association.

Returns:

  • (String)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#automation_target_parameter_nameString

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)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#calendar_namesArray<String>

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents you want to gate your associations 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>)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#compliance_severityString

The severity level to assign to the association.

Returns:

  • (String)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#document_versionString

The document version you want to associate with the targets. Can be a specific version or the default version.

State Manager doesn’t support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the ‘default` version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to `default`.

Returns:

  • (String)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#durationInteger

The number of hours the association can run before it is canceled. Duration applies to associations that are currently running, and any pending and in progress commands on all targets. If a target was taken offline for the association to run, it is made available again immediately, without a reboot.

The ‘Duration` parameter applies only when both these conditions are true:

  • The association for which you specify a duration is cancelable according to the parameters of the SSM command document or Automation runbook associated with this execution.

  • The command specifies the ‘ ApplyOnlyAtCronInterval ` parameter, which means that the association doesn’t run immediately after it is created, but only according to the specified schedule.

Returns:

  • (Integer)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :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)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :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)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :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)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#nameString

The name of the SSM Command document or Automation runbook that contains the configuration information for the managed node.

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

For Systems Manager documents (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:partition: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)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#output_locationTypes::InstanceAssociationOutputLocation

An Amazon Simple Storage Service (Amazon S3) bucket where you want to store the output details of the request.



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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#parametersHash<String,Array<String>>

The parameters for the runtime configuration of the document.

Returns:

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


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#schedule_expressionString

A cron expression when the association will be applied to the targets.

Returns:

  • (String)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#schedule_offsetInteger

Number of days to wait after the scheduled day to run an association. For example, if you specified a cron schedule of ‘cron(0 0 ? * THU#2 *)`, you could specify an offset of 3 to run the association each Sunday after the second Thursday of the month. For more information about cron schedules for associations, see

Reference: Cron and rate expressions for Systems Manager][1

in the

*Amazon Web Services Systems Manager User Guide*.

<note markdown=“1”> To use offsets, you must specify the ‘ApplyOnlyAtCronInterval` parameter. This option tells the system not to run an association immediately after you create it.

</note>

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html

Returns:

  • (Integer)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :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. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use ‘AUTO` mode.

Returns:

  • (String)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#tagsArray<Types::Tag>

Adds or overwrites one or more tags for a State Manager association. Tags are metadata that you can assign to your Amazon Web Services resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.

Returns:



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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#target_locationsArray<Types::TargetLocation>

A location is a combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association. Use this action to create an association in multiple Regions and multiple accounts.

Returns:



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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :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>>>)


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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#targetsArray<Types::Target>

The targets for the association. You can target managed nodes by using tags, Amazon Web Services resource groups, all managed nodes in an Amazon Web Services account, or individual managed node IDs. You can target all managed nodes in an Amazon Web Services account by specifying the ‘InstanceIds` key with a value of `*`. For more information about choosing targets for an association, see [Understanding targets and rate controls in State Manager associations] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-state-manager-targets-and-rate-controls.html

Returns:



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

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,
  :sync_compliance,
  :apply_only_at_cron_interval,
  :calendar_names,
  :target_locations,
  :schedule_offset,
  :duration,
  :target_maps,
  :tags,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end