class Amazonite::CloudFormation::StackEvent

Overview

The StackEvent data type.

Defined in:

cloudformation/stack_event.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(stack_id : String, event_id : String, stack_name : String, timestamp : Time, operation_id : String | Nil = nil, logical_resource_id : String | Nil = nil, physical_resource_id : String | Nil = nil, resource_type : String | Nil = nil, resource_status : ResourceStatus | Nil = nil, resource_status_reason : String | Nil = nil, resource_properties : String | Nil = nil, client_request_token : String | Nil = nil, hook_type : String | Nil = nil, hook_status : HookStatus | Nil = nil, hook_status_reason : String | Nil = nil, hook_invocation_point : HookInvocationPoint | Nil = nil, hook_invocation_id : String | Nil = nil, hook_failure_mode : HookFailureMode | Nil = nil, detailed_status : DetailedStatus | 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 client_request_token : String | Nil #

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.


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

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.


[View source]
def detailed_status : DetailedStatus | Nil #

An optional field that contains information about the detailed status of the stack event.

  • CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see Understand CloudFormation stack creation events in the CloudFormation User Guide.

  • VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.


[View source]
def detailed_status=(detailed_status : DetailedStatus | Nil) #

An optional field that contains information about the detailed status of the stack event.

  • CONFIGURATION_COMPLETE - all of the resources in the stack have reached that event. For more information, see Understand CloudFormation stack creation events in the CloudFormation User Guide.

  • VALIDATION_FAILED - template validation failed because of invalid properties in the template. The ResourceStatusReason field shows what properties are defined incorrectly.


[View source]
def event_id : String #

The unique identifier of this event.


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

The unique identifier of this event.


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

See Object#hash(hasher)


def hook_failure_mode : HookFailureMode | Nil #

Specify the Hook failure mode for non-compliant resources in the followings ways.

  • FAIL Stops provisioning resources.

  • WARN Allows provisioning to continue with a warning message.


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

Specify the Hook failure mode for non-compliant resources in the followings ways.

  • FAIL Stops provisioning resources.

  • WARN Allows provisioning to continue with a warning message.


[View source]
def hook_invocation_id : String | Nil #

The unique identifier of the Hook invocation.


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

The unique identifier of the Hook invocation.


[View source]
def hook_invocation_point : HookInvocationPoint | Nil #

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


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

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


[View source]
def hook_status : HookStatus | Nil #

Provides the status of the change set Hook.


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

Provides the status of the change set Hook.


[View source]
def hook_status_reason : String | Nil #

Provides the reason for the Hook status.


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

Provides the reason for the Hook status.


[View source]
def hook_type : String | Nil #

The name of the Hook.


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

The name of the Hook.


[View source]
def logical_resource_id : String | Nil #

The logical name of the resource specified in the template.


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

The logical name of the resource specified in the template.


[View source]
def operation_id : String | Nil #

The unique identifier of the operation that generated this stack event.


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

The unique identifier of the operation that generated this stack event.


[View source]
def physical_resource_id : String | Nil #

The name or unique identifier associated with the physical instance of the resource.


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

The name or unique identifier associated with the physical instance of the resource.


[View source]
def resource_properties : String | Nil #

BLOB of the properties used to create the resource.


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

BLOB of the properties used to create the resource.


[View source]
def resource_status : ResourceStatus | Nil #

Current status of the resource.


[View source]
def resource_status=(resource_status : ResourceStatus | Nil) #

Current status of the resource.


[View source]
def resource_status_reason : String | Nil #

Success/failure message associated with the resource.


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

Success/failure message associated with the resource.


[View source]
def resource_type : String | Nil #

Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.


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

Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.


[View source]
def stack_id : String #

The unique ID name of the instance of the stack.


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

The unique ID name of the instance of the stack.


[View source]
def stack_name : String #

The name associated with a stack.


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

The name associated with a stack.


[View source]
def timestamp : Time #

Time the status was updated.


[View source]
def timestamp=(timestamp : Time) #

Time the status was updated.


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

[View source]
def validate! : Nil #

[View source]