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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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"],
    },
  ],
  target_maps: [
    {
      "TargetMapKey" => ["TargetMapValue"],
    },
  ],
  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.

The Automation runbooks specified for the runbook workflow can't run until all required approvals for the change request have been received.

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)


18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18379

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :target_maps,
  :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)


18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18379

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :target_maps,
  :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)


18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18379

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :target_maps,
  :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)


18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18379

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :target_maps,
  :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>>)


18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18379

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :target_maps,
  :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:



18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18379

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

#target_mapsArray<Hash<String,Array<String>>>

A key-value mapping of runbook parameters to target resources. Both Targets and TargetMaps can't be specified together.

Returns:

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


18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18379

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :target_maps,
  :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)


18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18379

class Runbook < Struct.new(
  :document_name,
  :document_version,
  :parameters,
  :target_parameter_name,
  :targets,
  :target_maps,
  :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:



18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 18379

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