class Amazonite::Ssm::Runbook

• Amazonite::Ssm::Runbook
• Reference
• Object

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.

Included Modules

• JSON::Serializable

Defined in:

ssm/runbook.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(document_name : String, document_version : String | Nil = nil, parameters : Hash(String, Array(String)) | Nil = nil, target_parameter_name : String | Nil = nil, targets : Array(Target) | Nil = nil, target_maps : Array(Hash(String, Array(String))) | Nil = nil, max_concurrency : String | Nil = nil, max_errors : String | Nil = nil, target_locations : Array(TargetLocation) | Nil = nil)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #document_name : String

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

• #document_name=(document_name : String)

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

• #document_version : String | Nil

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

• #document_version=(document_version : String | Nil)

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

• #hash(hasher)

  See Object#hash(hasher)

• #max_concurrency : String | Nil

  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.

• #max_concurrency=(max_concurrency : String | Nil)

  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.

• #max_errors : String | Nil

  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.

• #max_errors=(max_errors : String | Nil)

  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.

• #parameters : Hash(String, Array(String)) | Nil

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

• #parameters=(parameters : Hash(String, Array(String)) | Nil)

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

• #target_locations : Array(TargetLocation) | Nil

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

• #target_locations=(target_locations : Array(TargetLocation) | Nil)

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

• #target_maps : Array(Hash(String, Array(String))) | Nil

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

• #target_maps=(target_maps : Array(Hash(String, Array(String))) | Nil)

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

• #target_parameter_name : String | Nil

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

• #target_parameter_name=(target_parameter_name : String | Nil)

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

• #targets : Array(Target) | Nil

  A key-value mapping to target resources that the runbook operation performs tasks on.

• #targets=(targets : Array(Target) | Nil)

  A key-value mapping to target resources that the runbook operation performs tasks on.

• #validate! : Nil

Constructor Detail

Instance Method Detail