Class: Aws::SSM::Types::StartAutomationExecutionRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::StartAutomationExecutionRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alarm_configuration ⇒ Types::AlarmConfiguration

  The CloudWatch alarm you want to apply to your automation.

• #client_token ⇒ String

  User-provided idempotency token.

• #document_name ⇒ String

  The name of the SSM document to run.

• #document_version ⇒ String

  The version of the Automation runbook to use for this execution.

• #max_concurrency ⇒ String

  The maximum number of targets allowed to run this task in parallel.

• #max_errors ⇒ String

  The number of errors that are allowed before the system stops running the automation on additional targets.

• #mode ⇒ String

  The execution mode of the automation.

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

  A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

• #tags ⇒ Array<Types::Tag>

  Optional metadata that you assign to a resource.

• #target_locations ⇒ Array<Types::TargetLocation>

  A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation.

• #target_locations_url ⇒ String

  Specify a publicly accessible URL for a file that contains the ‘TargetLocations` body.

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

  A key-value mapping of document parameters to target resources.

• #target_parameter_name ⇒ String

  The name of the parameter used as the target resource for the rate-controlled execution.

• #targets ⇒ Array<Types::Target>

  A key-value mapping to target resources.

Instance Attribute Details

#alarm_configuration ⇒ Types::AlarmConfiguration

The CloudWatch alarm you want to apply to your automation.

Returns:

• (Types::AlarmConfiguration)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can’t be reused.

Returns:

• (String)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#document_name ⇒ String

The name of the SSM document to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see [Sharing SSM documents] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/documents-ssm-sharing.html

Returns:

• (String)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#document_version ⇒ String

The version of the Automation runbook to use for this execution.

Returns:

• (String)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#max_concurrency ⇒ String

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is ‘10`.

If both this parameter and the ‘TargetLocation:TargetsMaxConcurrency` are supplied, `TargetLocation:TargetsMaxConcurrency` takes precedence.

Returns:

• (String)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#max_errors ⇒ String

The number of errors that are allowed before the system stops running the automation 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 running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors 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 max-concurrency to 1 so the executions proceed one at a time.

If this parameter and the ‘TargetLocation:TargetsMaxErrors` parameter are both supplied, `TargetLocation:TargetsMaxErrors` takes precedence.

Returns:

• (String)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#mode ⇒ String

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

Returns:

• (String)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Returns:

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

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

• ‘Key=environment,Value=test`

• ‘Key=OS,Value=Windows`

<note markdown=“1”> To add tags to an existing automation, use the AddTagsToResource operation.

</note>

Returns:

• (Array<Types::Tag>)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#target_locations ⇒ Array<Types::TargetLocation>

A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple Amazon Web Services accounts. For more information, see [Running automations in multiple Amazon Web Services Regions and accounts] in the *Amazon Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html

Returns:

• (Array<Types::TargetLocation>)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#target_locations_url ⇒ String

Specify a publicly accessible URL for a file that contains the ‘TargetLocations` body. Currently, only files in presigned Amazon S3 buckets are supported.

Returns:

• (String)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  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 18090

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#target_parameter_name ⇒ String

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Returns:

• (String)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end

#targets ⇒ Array<Types::Target>

A key-value mapping to target resources. Required if you specify TargetParameterName.

If both this parameter and the ‘TargetLocation:Targets` parameter are supplied, `TargetLocation:Targets` takes precedence.

Returns:

• (Array<Types::Target>)

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

class StartAutomationExecutionRequest < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :client_token,
  :mode,
  :target_parameter_name,
  :targets,
  :target_maps,
  :max_concurrency,
  :max_errors,
  :target_locations,
  :tags,
  :alarm_configuration,
  :target_locations_url)
  SENSITIVE = []
  include Aws::Structure
end