events
Creates, updates, deletes, gets or lists an events resource.
Overview
| Name | events |
| Type | Resource |
| Id | aws.cloudformation.events |
Fields
The following fields are returned by SELECT queries:
- describe_events
| Name | Datatype | Description |
|---|---|---|
client_request_token | string | A unique identifier for the request that initiated this operation. |
detailed_status | string | Additional status information about the operation. |
end_time | string | The time when the event ended. |
event_id | string | A unique identifier for this event. |
event_type | string | The type of event. |
hook_failure_mode | string | Specifies how Hook failures are handled. |
hook_invocation_point | string | The point in the operation lifecycle when the Hook was invoked. |
hook_status | string | The status of the Hook invocation. |
hook_status_reason | string | Additional information about the Hook status. |
hook_type | string | The type name of the Hook that was invoked. |
logical_resource_id | string | The logical name of the resource as specified in the template. |
operation_id | string | The unique identifier of the operation this event belongs to. |
operation_status | string | The current status of the operation. |
operation_type | string | The type of operation. |
physical_resource_id | string | The name or unique identifier that corresponds to a physical instance ID of a resource. |
resource_properties | string | The properties used to create the resource. |
resource_status | string | Current status of the resource. |
resource_status_reason | string | Success or failure message associated with the resource. |
resource_type | string | Type of resource. |
stack_id | string | The unique ID name of the instance of the stack. |
start_time | string | The time when the event started. |
timestamp | string | Time the status was updated. |
validation_failure_mode | string | Specifies how validation failures are handled. |
validation_name | string | The name of the validation that was performed. |
validation_path | string | The path within the resource where the validation was applied. |
validation_status | string | The status of the validation. |
validation_status_reason | string | Additional information about the validation status. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_events | select | region | StackName, ChangeSetName, OperationId, Filters, NextToken | 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. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
ChangeSetName | string | The name or Amazon Resource Name (ARN) of the change set for which you want to retrieve events. |
Filters | object | Filters to apply when retrieving events. |
NextToken | string | The token for the next set of items to return. (You received this token from a previous call.) |
OperationId | string | The unique identifier of the operation for which you want to retrieve events. |
StackName | string | The 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
- describe_events
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 }}'
;