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

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

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_name ⇒ String

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

Returns:

  • (String) 


17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17336

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_version ⇒ String

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

Returns:

  • (String) 


17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17336

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_concurrency ⇒ String

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) 


17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17336

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_errors ⇒ String

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) 


17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17336

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

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

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

Returns:

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


17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17336

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_locations ⇒ Array<Types::TargetLocation>

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

Returns:



17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17336

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_maps ⇒ Array<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>>>) 


17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17336

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_name ⇒ String

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

Returns:

  • (String) 


17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17336

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

#targets ⇒ Array<Types::Target>

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

Returns:



17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17336

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