Class: Aws::SSM::Types::Runbook

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

Overview

Note:

When making an API call, you may pass Runbook data as a hash:

{
  document_name: "DocumentARN", # required
  document_version: "DocumentVersion",
  parameters: {
    "AutomationParameterKey" => ["AutomationParameterValue"],
  },
  target_parameter_name: "AutomationParameterKey",
  targets: [
    {
      key: "TargetKey",
      values: ["TargetValue"],
    },
  ],
  max_concurrency: "MaxConcurrency",
  max_errors: "MaxErrors",
  target_locations: [
    {
      accounts: ["Account"],
      regions: ["Region"],
      target_location_max_concurrency: "MaxConcurrency",
      target_location_max_errors: "MaxErrors",
      execution_role_name: "ExecutionRoleName",
    },
  ],
}

Information about an Automation runbook used in a runbook workflow in Change Manager.

<note markdown=“1”> The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

</note>

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_nameString

The name of the Automation runbook used in a runbook workflow.

Returns:

  • (String)

17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
# File 'lib/aws-sdk-ssm/types.rb', line 17912

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :max_concurrency,
  :max_errors,
  :target_locations)
  SENSITIVE = []
  include Aws::Structure
end

#document_versionString

The version of the Automation runbook used in a runbook workflow.

Returns:

  • (String)

17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
# File 'lib/aws-sdk-ssm/types.rb', line 17912

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :max_concurrency,
  :max_errors,
  :target_locations)
  SENSITIVE = []
  include Aws::Structure
end

#max_concurrencyString

The `MaxConcurrency` value specified by the user when the operation started, indicating the maximum number of resources that the runbook operation can run on at the same time.

Returns:

  • (String)

17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
# File 'lib/aws-sdk-ssm/types.rb', line 17912

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :max_concurrency,
  :max_errors,
  :target_locations)
  SENSITIVE = []
  include Aws::Structure
end

#max_errorsString

The `MaxErrors` value specified by the user when the execution started, indicating the maximum number of errors that can occur during the operation before the updates are stopped or rolled back.

Returns:

  • (String)

17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
# File 'lib/aws-sdk-ssm/types.rb', line 17912

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :max_concurrency,
  :max_errors,
  :target_locations)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,Array<String>>

The key-value map of execution parameters, which were supplied when calling `StartChangeRequestExecution`.

Returns:

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

17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
# File 'lib/aws-sdk-ssm/types.rb', line 17912

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :max_concurrency,
  :max_errors,
  :target_locations)
  SENSITIVE = []
  include Aws::Structure
end

#target_locationsArray<Types::TargetLocation>

Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Runbook operation.

Returns:


17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
# File 'lib/aws-sdk-ssm/types.rb', line 17912

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :max_concurrency,
  :max_errors,
  :target_locations)
  SENSITIVE = []
  include Aws::Structure
end

#target_parameter_nameString

The name of the parameter used as the target resource for the rate-controlled runbook workflow. Required if you specify `Targets`.

Returns:

  • (String)

17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
# File 'lib/aws-sdk-ssm/types.rb', line 17912

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :max_concurrency,
  :max_errors,
  :target_locations)
  SENSITIVE = []
  include Aws::Structure
end

#targetsArray<Types::Target>

A key-value mapping to target resources that the runbook operation performs tasks on. Required if you specify `TargetParameterName`.

Returns:


17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
# File 'lib/aws-sdk-ssm/types.rb', line 17912

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :max_concurrency,
  :max_errors,
  :target_locations)
  SENSITIVE = []
  include Aws::Structure
end