class Amazonite::Ssm::AutomationExecutionPreview

Overview

Information about the results of the execution preview.

Included Modules

Defined in:

ssm/automation_execution_preview.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(step_previews : Hash(ImpactType, Int32) | Nil = nil, regions : Array(String) | Nil = nil, target_previews : Array(TargetPreview) | Nil = nil, total_accounts : Int32 | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def regions : Array(String) | Nil #

Information about the Amazon Web Services Regions targeted by the execution preview.


[View source]
def regions=(regions : Array(String) | Nil) #

Information about the Amazon Web Services Regions targeted by the execution preview.


[View source]
def step_previews : Hash(ImpactType, Int32) | Nil #

Information about the type of impact a runbook step would have on a resource.

  • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

  • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

  • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.


[View source]
def step_previews=(step_previews : Hash(ImpactType, Int32) | Nil) #

Information about the type of impact a runbook step would have on a resource.

  • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

  • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

  • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.


[View source]
def target_previews : Array(TargetPreview) | Nil #

Information that provides a preview of what the impact of running the specified Automation runbook would be.


[View source]
def target_previews=(target_previews : Array(TargetPreview) | Nil) #

Information that provides a preview of what the impact of running the specified Automation runbook would be.


[View source]
def total_accounts : Int32 | Nil #

Information about the Amazon Web Services accounts that were included in the execution preview.


[View source]
def total_accounts=(total_accounts : Int32 | Nil) #

Information about the Amazon Web Services accounts that were included in the execution preview.


[View source]
def validate! : Nil #

[View source]