class Amazonite::Ssm::StepExecution

• Amazonite::Ssm::StepExecution
• Reference
• Object

Overview

Detailed information about an the execution state of an Automation step.

Included Modules

• JSON::Serializable

Defined in:

ssm/step_execution.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(step_name : String | Nil = nil, action : String | Nil = nil, timeout_seconds : Int64 | Nil = nil, on_failure : String | Nil = nil, max_attempts : Int32 | Nil = nil, execution_start_time : Time | Nil = nil, execution_end_time : Time | Nil = nil, step_status : AutomationExecutionStatus | Nil = nil, response_code : String | Nil = nil, inputs : Hash(String, String) | Nil = nil, outputs : Hash(String, Array(String)) | Nil = nil, response : String | Nil = nil, failure_message : String | Nil = nil, warning_message : String | Nil = nil, failure_details : FailureDetails | Nil = nil, step_execution_id : String | Nil = nil, overridden_parameters : Hash(String, Array(String)) | Nil = nil, is_end : Bool | Nil = nil, next_step : String | Nil = nil, is_critical : Bool | Nil = nil, valid_next_steps : Array(String) | Nil = nil, targets : Array(Target) | Nil = nil, target_location : TargetLocation | Nil = nil, triggered_alarms : Array(AlarmStateInformation) | Nil = nil, parent_step_details : ParentStepDetails | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #action : String | Nil

  The action this step performs.

• #action=(action : String | Nil)

  The action this step performs.

• #execution_end_time : Time | Nil

  If a step has finished execution, this contains the time the execution ended.

• #execution_end_time=(execution_end_time : Time | Nil)

  If a step has finished execution, this contains the time the execution ended.

• #execution_start_time : Time | Nil

  If a step has begun execution, this contains the time the step started.

• #execution_start_time=(execution_start_time : Time | Nil)

  If a step has begun execution, this contains the time the step started.

• #failure_details : FailureDetails | Nil

  Information about the Automation failure.

• #failure_details=(failure_details : FailureDetails | Nil)

  Information about the Automation failure.

• #failure_message : String | Nil

  If a step failed, this message explains why the execution failed.

• #failure_message=(failure_message : String | Nil)

  If a step failed, this message explains why the execution failed.

• #hash(hasher)

  See Object#hash(hasher)

• #inputs : Hash(String, String) | Nil

  Fully-resolved values passed into the step before execution.

• #inputs=(inputs : Hash(String, String) | Nil)

  Fully-resolved values passed into the step before execution.

• #is_critical : Bool | Nil

  The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

• #is_critical=(is_critical : Bool | Nil)

  The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

• #is_end : Bool | Nil

  The flag which can be used to end automation no matter whether the step succeeds or fails.

• #is_end=(is_end : Bool | Nil)

  The flag which can be used to end automation no matter whether the step succeeds or fails.

• #max_attempts : Int32 | Nil

  The maximum number of tries to run the action of the step.

• #max_attempts=(max_attempts : Int32 | Nil)

  The maximum number of tries to run the action of the step.

• #next_step : String | Nil

  The next step after the step succeeds.

• #next_step=(next_step : String | Nil)

  The next step after the step succeeds.

• #on_failure : String | Nil

  The action to take if the step fails.

• #on_failure=(on_failure : String | Nil)

  The action to take if the step fails.

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

  Returned values from the execution of the step.

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

  Returned values from the execution of the step.

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

  A user-specified list of parameters to override when running a step.

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

  A user-specified list of parameters to override when running a step.

• #parent_step_details : ParentStepDetails | Nil

  Information about the parent step.

• #parent_step_details=(parent_step_details : ParentStepDetails | Nil)

  Information about the parent step.

• #response : String | Nil

  A message associated with the response code for an execution.

• #response=(response : String | Nil)

  A message associated with the response code for an execution.

• #response_code : String | Nil

  The response code returned by the execution of the step.

• #response_code=(response_code : String | Nil)

  The response code returned by the execution of the step.

• #step_execution_id : String | Nil

  The unique ID of a step execution.

• #step_execution_id=(step_execution_id : String | Nil)

  The unique ID of a step execution.

• #step_name : String | Nil

  The name of this execution step.

• #step_name=(step_name : String | Nil)

  The name of this execution step.

• #step_status : AutomationExecutionStatus | Nil

  The execution status for this step.

• #step_status=(step_status : AutomationExecutionStatus | Nil)

  The execution status for this step.

• #target_location : TargetLocation | Nil

  The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

• #target_location=(target_location : TargetLocation | Nil)

  The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

• #targets : Array(Target) | Nil

  The targets for the step execution.

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

  The targets for the step execution.

• #timeout_seconds : Int64 | Nil

  The timeout seconds of the step.

• #timeout_seconds=(timeout_seconds : Int64 | Nil)

  The timeout seconds of the step.

• #triggered_alarms : Array(AlarmStateInformation) | Nil

  The CloudWatch alarms that were invoked by the automation.

• #triggered_alarms=(triggered_alarms : Array(AlarmStateInformation) | Nil)

  The CloudWatch alarms that were invoked by the automation.

• #valid_next_steps : Array(String) | Nil

  Strategies used when step fails, we support Continue and Abort.

• #valid_next_steps=(valid_next_steps : Array(String) | Nil)

  Strategies used when step fails, we support Continue and Abort.

• #validate! : Nil
• #warning_message : String | Nil

  A message that describes a non-critical issue that occurred during the step execution.

• #warning_message=(warning_message : String | Nil)

  A message that describes a non-critical issue that occurred during the step execution.

Constructor Detail

Instance Method Detail