class Amazonite::Ssm::SendAutomationSignalRequest

Included Modules

Defined in:

ssm/send_automation_signal_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(automation_execution_id : String, signal_type : SignalType, payload : Hash(String, Array(String)) | Nil = nil) #

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

[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 automation_execution_id : String #

The unique identifier for an existing Automation execution that you want to send the signal to.


[View source]
def automation_execution_id=(automation_execution_id : String) #

The unique identifier for an existing Automation execution that you want to send the signal to.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def payload : Hash(String, Array(String)) | Nil #

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"


[View source]
def payload=(payload : Hash(String, Array(String)) | Nil) #

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"


[View source]
def signal_type : SignalType #

The type of signal to send to an Automation execution.


[View source]
def signal_type=(signal_type : SignalType) #

The type of signal to send to an Automation execution.


[View source]
def validate! : Nil #

[View source]