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

Inherits:

Struct

Object
Struct
Aws::SSM::Types::CreateAssociationBatchRequestEntry

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-ssm/types.rb

Overview

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

#alarm_configuration ⇒ Types::AlarmConfiguration

The details for the CloudWatch alarm you want to apply to an automation or command.
#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_name ⇒ String

Specify a descriptive name for the association.
#automation_target_parameter_name ⇒ String

Specify the target for the association.
#calendar_names ⇒ Array<String>

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under.
#compliance_severity ⇒ String

The severity level to assign to the association.
#document_version ⇒ String

The document version.
#duration ⇒ Integer

The number of hours the association can run before it is canceled.
#instance_id ⇒ String

The managed node 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 SSM document that contains the configuration information for the managed node.
#output_location ⇒ Types::InstanceAssociationOutputLocation

An S3 bucket where you want to store the results of this request.
#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.
#schedule_offset ⇒ Integer

Number of days to wait after the scheduled day to run an association.
#sync_compliance ⇒ String

The mode for generating association compliance.
#target_locations ⇒ Array<Types::TargetLocation>

Use this action to create an association in multiple Regions and multiple accounts.
#target_maps ⇒ Array<Hash<String,Array<String>>>

A key-value mapping of document parameters to target resources.
#targets ⇒ Array<Types::Target>

The managed nodes targeted by the request.

Instance Attribute Details

#alarm_configuration ⇒ `Types::AlarmConfiguration`

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

Returns:

(Types::AlarmConfiguration)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#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. This parameter isn’t supported for rate expressions.

Returns:

(Boolean)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#association_name ⇒ `String`

Specify a descriptive name for the association.

Returns:

(String)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  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 runbook and target resources by using rate controls. Automation is a capability of Amazon Web Services Systems Manager.

Returns:

(String)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#calendar_names ⇒ `Array<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>)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#compliance_severity ⇒ `String`

The severity level to assign to the association.

Returns:

(String)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#document_version ⇒ `String`

The document version.

Returns:

(String)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#duration ⇒ `Integer`

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)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#instance_id ⇒ `String`

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)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  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 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)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  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 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)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#name ⇒ `String`

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)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#output_location ⇒ `Types::InstanceAssociationOutputLocation`

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

Returns:

(Types::InstanceAssociationOutputLocation)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

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

A description of the parameters for a document.

Returns:

(Hash<String,Array<String>>)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#schedule_expression ⇒ `String`

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

Returns:

(String)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#schedule_offset ⇒ `Integer`

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

Returns:

(Integer)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  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 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)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#target_locations ⇒ `Array<Types::TargetLocation>`

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

Returns:

(Array<Types::TargetLocation>)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#target_maps ⇒ `Array<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>>>)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

#targets ⇒ `Array<Types::Target>`

The managed nodes targeted by the request.

Returns:

(Array<Types::Target>)

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

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,
  :duration,
  :target_maps,
  :alarm_configuration)
  SENSITIVE = [:parameters]
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_configuration ⇒ Types::AlarmConfiguration

#apply_only_at_cron_interval ⇒ Boolean

#association_name ⇒ String

#automation_target_parameter_name ⇒ String

#calendar_names ⇒ Array<String>

#compliance_severity ⇒ String

#document_version ⇒ String

#duration ⇒ Integer

#instance_id ⇒ String

#max_concurrency ⇒ String

#max_errors ⇒ String

#name ⇒ String

#output_location ⇒ Types::InstanceAssociationOutputLocation

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

#schedule_expression ⇒ String

#schedule_offset ⇒ Integer

#sync_compliance ⇒ String

#target_locations ⇒ Array<Types::TargetLocation>

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

#targets ⇒ Array<Types::Target>

#alarm_configuration ⇒ `Types::AlarmConfiguration`

#apply_only_at_cron_interval ⇒ `Boolean`

#association_name ⇒ `String`

#automation_target_parameter_name ⇒ `String`

#calendar_names ⇒ `Array<String>`

#compliance_severity ⇒ `String`

#document_version ⇒ `String`

#duration ⇒ `Integer`

#instance_id ⇒ `String`

#max_concurrency ⇒ `String`

#max_errors ⇒ `String`

#name ⇒ `String`

#output_location ⇒ `Types::InstanceAssociationOutputLocation`

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

#schedule_expression ⇒ `String`

#schedule_offset ⇒ `Integer`

#sync_compliance ⇒ `String`

#target_locations ⇒ `Array<Types::TargetLocation>`

#target_maps ⇒ `Array<Hash<String,Array<String>>>`

#targets ⇒ `Array<Types::Target>`