stack_events

Creates, updates, deletes, gets or lists a stack_events resource.

Overview

Name	stack_events
Type	Resource
Id	aws.cloudformation.stack_events

Fields

The following fields are returned by SELECT queries:

describe_stack_events

Name	Datatype	Description
client_request_token	string	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.
detailed_status	string	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.
event_id	string	The unique identifier of this event.
hook_failure_mode	string	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.
hook_invocation_id	string	The unique identifier of the Hook invocation.
hook_invocation_point	string	The specific point in the provisioning process where the Hook is invoked.
hook_status	string	Provides the status of the change set Hook.
hook_status_reason	string	Provides the reason for the Hook status.
hook_type	string	The name of the Hook.
logical_resource_id	string	The logical name of the resource specified in the template.
operation_id	string	The unique identifier of the operation that generated this stack event.
physical_resource_id	string	The name or unique identifier associated with the physical instance of the resource.
resource_properties	string	BLOB of the properties used to create the resource.
resource_status	string	Current status of the resource.
resource_status_reason	string	Success/failure message associated with the resource.
resource_type	string	Type of resource. For more information, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
stack_id	string	The unique ID name of the instance of the stack.
stack_name	string	The name associated with a stack.
timestamp	string	Time the status was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_stack_events	select	StackName, region	NextToken	Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
StackName	string	The name or the unique stack ID that's associated with the stack, which aren't always interchangeable: Running stacks: You can specify either the stack's name or its unique stack ID. Deleted stacks: You must specify the unique stack ID.
region	string	AWS region (default: us-east-1)
NextToken	string	The token for the next set of items to return. (You received this token from a previous call.)

SELECT examples

describe_stack_events

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, see Understand CloudFormation stack creation events in the CloudFormation User Guide. You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

SELECT
client_request_token,
detailed_status,
event_id,
hook_failure_mode,
hook_invocation_id,
hook_invocation_point,
hook_status,
hook_status_reason,
hook_type,
logical_resource_id,
operation_id,
physical_resource_id,
resource_properties,
resource_status,
resource_status_reason,
resource_type,
stack_id,
stack_name,
timestamp
FROM aws.cloudformation.stack_events
WHERE StackName = '{{ StackName }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
;