class Amazonite::CloudFormation::HookResultSummary

Overview

A ListHookResults call returns a summary of a Hook invocation.

Defined in:

cloudformation/hook_result_summary.cr

Constructors

Instance Method Summary

Constructor Detail

def self.from_xml(node : XML::Node) : self #

[View source]
def self.new(hook_result_id : String | Nil = nil, invocation_point : HookInvocationPoint | Nil = nil, failure_mode : HookFailureMode | Nil = nil, type_name : String | Nil = nil, type_version_id : String | Nil = nil, type_configuration_version_id : String | Nil = nil, status : HookStatus | Nil = nil, hook_status_reason : String | Nil = nil, invoked_at : Time | Nil = nil, target_type : ListHookResultsTargetType | Nil = nil, target_id : String | Nil = nil, type_arn : String | Nil = nil, hook_execution_target : String | Nil = nil) #

[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 failure_mode : HookFailureMode | Nil #

The failure mode of the invocation.


[View source]
def failure_mode=(failure_mode : HookFailureMode | Nil) #

The failure mode of the invocation.


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

See Object#hash(hasher)


def hook_execution_target : String | Nil #

The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.

Only shown in responses when the request does not specify TargetType and TargetId filters.


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

The Amazon Resource Name (ARN) of the target stack or request token of the Cloud Control API operation.

Only shown in responses when the request does not specify TargetType and TargetId filters.


[View source]
def hook_result_id : String | Nil #

The unique identifier for this Hook invocation result.


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

The unique identifier for this Hook invocation result.


[View source]
def hook_status_reason : String | Nil #

A description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.


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

A description of the Hook results status. For example, if the Hook result is in a failed state, this may contain additional information for the failed state.


[View source]
def invocation_point : HookInvocationPoint | Nil #

The specific point in the provisioning process where the Hook is invoked.


[View source]
def invocation_point=(invocation_point : HookInvocationPoint | Nil) #

The specific point in the provisioning process where the Hook is invoked.


[View source]
def invoked_at : Time | Nil #

The timestamp when the Hook was invoked.

Only shown in responses when the request does not specify TargetType and TargetId filters.


[View source]
def invoked_at=(invoked_at : Time | Nil) #

The timestamp when the Hook was invoked.

Only shown in responses when the request does not specify TargetType and TargetId filters.


[View source]
def status : HookStatus | Nil #

The status of the Hook invocation. The following statuses are possible:

  • HOOK_IN_PROGRESS: The Hook is currently running.

  • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

  • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

  • HOOK_FAILED: The Hook encountered an error during execution.


[View source]
def status=(status : HookStatus | Nil) #

The status of the Hook invocation. The following statuses are possible:

  • HOOK_IN_PROGRESS: The Hook is currently running.

  • HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

  • HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

  • HOOK_FAILED: The Hook encountered an error during execution.


[View source]
def target_id : String | Nil #

The unique identifier of the Hook invocation target.


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

The unique identifier of the Hook invocation target.


[View source]
def target_type : ListHookResultsTargetType | Nil #

The target type that the Hook was invoked against.


[View source]
def target_type=(target_type : ListHookResultsTargetType | Nil) #

The target type that the Hook was invoked against.


[View source]
def to_query_params(prefix : String) : Array(Tuple(String, String)) #

[View source]
def type_arn : String | Nil #

The ARN of the Hook that was invoked.


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

The ARN of the Hook that was invoked.


[View source]
def type_configuration_version_id : String | Nil #

The version of the Hook configuration.


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

The version of the Hook configuration.


[View source]
def type_name : String | Nil #

The name of the Hook that was invoked.


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

The name of the Hook that was invoked.


[View source]
def type_version_id : String | Nil #

The version of the Hook that was invoked.


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

The version of the Hook that was invoked.


[View source]
def validate! : Nil #

[View source]