Skip to main content

events

Creates, updates, deletes, gets or lists an events resource.

Overview

Nameevents
TypeResource
Idaws.cloudformation.events

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
client_request_tokenstringA unique identifier for the request that initiated this operation.
detailed_statusstringAdditional status information about the operation.
end_timestringThe time when the event ended.
event_idstringA unique identifier for this event.
event_typestringThe type of event.
hook_failure_modestringSpecifies how Hook failures are handled.
hook_invocation_pointstringThe point in the operation lifecycle when the Hook was invoked.
hook_statusstringThe status of the Hook invocation.
hook_status_reasonstringAdditional information about the Hook status.
hook_typestringThe type name of the Hook that was invoked.
logical_resource_idstringThe logical name of the resource as specified in the template.
operation_idstringThe unique identifier of the operation this event belongs to.
operation_statusstringThe current status of the operation.
operation_typestringThe type of operation.
physical_resource_idstringThe name or unique identifier that corresponds to a physical instance ID of a resource.
resource_propertiesstringThe properties used to create the resource.
resource_statusstringCurrent status of the resource.
resource_status_reasonstringSuccess or failure message associated with the resource.
resource_typestringType of resource.
stack_idstringThe unique ID name of the instance of the stack.
start_timestringThe time when the event started.
timestampstringTime the status was updated.
validation_failure_modestringSpecifies how validation failures are handled.
validation_namestringThe name of the validation that was performed.
validation_pathstringThe path within the resource where the validation was applied.
validation_statusstringThe status of the validation.
validation_status_reasonstringAdditional information about the validation status.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_eventsselectregionStackName, ChangeSetName, OperationId, Filters, NextTokenReturns CloudFormation events based on flexible query criteria. Groups events by operation ID, enabling you to focus on individual stack operations during deployment. An operation is any action performed on a stack, including stack lifecycle actions (Create, Update, Delete, Rollback), change set creation, nested stack creation, and automatic rollbacks triggered by failures. Each operation has a unique identifier (Operation ID) and represents a discrete change attempt on the stack. Returns different types of events including: Progress events - Status updates during stack operation execution. Validation errors - Failures from CloudFormation Early Validations. Provisioning errors - Resource creation and update failures. Hook invocation errors - Failures from CloudFormation Hook during stack operations. One of ChangeSetName, OperationId or StackName must be specified as input.

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.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)
ChangeSetNamestringThe name or Amazon Resource Name (ARN) of the change set for which you want to retrieve events.
FiltersobjectFilters to apply when retrieving events.
NextTokenstringThe token for the next set of items to return. (You received this token from a previous call.)
OperationIdstringThe unique identifier of the operation for which you want to retrieve events.
StackNamestringThe name or unique stack ID for which you want to retrieve events. If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

SELECT examples

Returns CloudFormation events based on flexible query criteria. Groups events by operation ID, enabling you to focus on individual stack operations during deployment. An operation is any action performed on a stack, including stack lifecycle actions (Create, Update, Delete, Rollback), change set creation, nested stack creation, and automatic rollbacks triggered by failures. Each operation has a unique identifier (Operation ID) and represents a discrete change attempt on the stack. Returns different types of events including: Progress events - Status updates during stack operation execution. Validation errors - Failures from CloudFormation Early Validations. Provisioning errors - Resource creation and update failures. Hook invocation errors - Failures from CloudFormation Hook during stack operations. One of ChangeSetName, OperationId or StackName must be specified as input.

SELECT
client_request_token,
detailed_status,
end_time,
event_id,
event_type,
hook_failure_mode,
hook_invocation_point,
hook_status,
hook_status_reason,
hook_type,
logical_resource_id,
operation_id,
operation_status,
operation_type,
physical_resource_id,
resource_properties,
resource_status,
resource_status_reason,
resource_type,
stack_id,
start_time,
timestamp,
validation_failure_mode,
validation_name,
validation_path,
validation_status,
validation_status_reason
FROM aws.cloudformation.events
WHERE region = '{{ region }}' -- required
AND StackName = '{{ StackName }}'
AND ChangeSetName = '{{ ChangeSetName }}'
AND OperationId = '{{ OperationId }}'
AND Filters = '{{ Filters }}'
AND NextToken = '{{ NextToken }}'
;