You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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
}

Describes the association of a Systems Manager SSM document and an instance.

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.
#instance_id ⇒ String
The ID of the instance.
#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 Amazon 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.
#targets ⇒ Array<Types::Target>
The instances targeted by the request.

Instance Attribute Details

#association_name ⇒ `String`

Specify a descriptive name for the association.

Returns:

(String)

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

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)
  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.

Returns:

(String)

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

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)
  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 2389

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)
  include Aws::Structure
end

#document_version ⇒ `String`

The document version.

Returns:

(String)

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

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)
  include Aws::Structure
end

#instance_id ⇒ `String`

The ID of the instance.

Returns:

(String)

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

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)
  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 2389

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)
  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 2389

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)
  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 documents.

You can specify AWS-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 AWS 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 AWS-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 2389

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)
  include Aws::Structure
end

#output_location ⇒ `Types::InstanceAssociationOutputLocation`

An Amazon 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 2389

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)
  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 2389

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)
  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 2389

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)
  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 2389

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)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#association_name ⇒ String

#automation_target_parameter_name ⇒ 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

#targets ⇒ Array<Types::Target>

#association_name ⇒ `String`

#automation_target_parameter_name ⇒ `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`

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