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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-ssm/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",
    },
  ],
}

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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.
#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 SSM document that contains the configuration information for the instance.
#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.
#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.
#targets ⇒ Array<Types::Target>
The instances targeted by the request.

Instance Attribute Details

#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 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3040

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)
  SENSITIVE = []
  include Aws::Structure
end

#association_name ⇒ `String`

Specify a descriptive name for the association.

Returns:

(String)

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

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)
  SENSITIVE = []
  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 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3040

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)
  SENSITIVE = []
  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.

Returns:

(Array<String>)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_severity ⇒ `String`

The severity level to assign to the association.

Returns:

(String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#document_version ⇒ `String`

The document version.

Returns:

(String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ `String`

The instance ID.

InstanceId has been deprecated. To specify an instance 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.

Returns:

(String)

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

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)
  SENSITIVE = []
  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 run an association while Systems Manager is running 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.

Returns:

(String)

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

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)
  SENSITIVE = []
  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.

Returns:

(String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the SSM document that contains the configuration information for the instance. 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 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3040

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)
  SENSITIVE = []
  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 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3040

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)
  SENSITIVE = []
  include Aws::Structure
end

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

A description of the parameters for a document.

Returns:

(Hash<String,Array<String>>)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ `String`

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

Returns:

(String)

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

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)
  SENSITIVE = []
  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 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3040

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)
  SENSITIVE = []
  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 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3040

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)
  SENSITIVE = []
  include Aws::Structure
end

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

The instances targeted by the request.

Returns:

(Array<Types::Target>)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#apply_only_at_cron_interval ⇒ Boolean

#association_name ⇒ String

#automation_target_parameter_name ⇒ String

#calendar_names ⇒ Array<String>

#compliance_severity ⇒ String

#document_version ⇒ String

#instance_id ⇒ String

#max_concurrency ⇒ String

#max_errors ⇒ String

#name ⇒ String

#output_location ⇒ Types::InstanceAssociationOutputLocation

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

#schedule_expression ⇒ String

#sync_compliance ⇒ String

#target_locations ⇒ Array<Types::TargetLocation>

#targets ⇒ Array<Types::Target>

#apply_only_at_cron_interval ⇒ `Boolean`

#association_name ⇒ `String`

#automation_target_parameter_name ⇒ `String`

#calendar_names ⇒ `Array<String>`

#compliance_severity ⇒ `String`

#document_version ⇒ `String`

#instance_id ⇒ `String`

#max_concurrency ⇒ `String`

#max_errors ⇒ `String`

#name ⇒ `String`

#output_location ⇒ `Types::InstanceAssociationOutputLocation`

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

#schedule_expression ⇒ `String`

#sync_compliance ⇒ `String`

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

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