Skip to content

StackEvent

Source code in docs_src/capo_cloudformation/types/stack_event.py
class StackEvent(TypedDict, closed=True):
    stack_id: NotRequired["capo_cloudformation.types.stack_id.StackId"]
    """<p>The unique ID name of the instance of the stack.</p>"""
    event_id: NotRequired["capo_cloudformation.types.event_id.EventId"]
    """<p>The unique identifier of this event.</p>"""
    stack_name: NotRequired["capo_cloudformation.types.stack_name.StackName"]
    """<p>The name associated with a stack.</p>"""
    operation_id: NotRequired["capo_cloudformation.types.operation_id.OperationId"]
    """<p>The unique identifier of the operation that generated this stack event.</p>"""
    logical_resource_id: NotRequired[
        "capo_cloudformation.types.logical_resource_id.LogicalResourceId"
    ]
    """<p>The logical name of the resource specified in the template.</p>"""
    physical_resource_id: NotRequired[
        "capo_cloudformation.types.physical_resource_id.PhysicalResourceId"
    ]
    """<p>The name or unique identifier associated with the physical instance of the resource.</p>"""
    resource_type: NotRequired["capo_cloudformation.types.resource_type.ResourceType"]
    """<p>Type of resource. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the <i>CloudFormation User Guide</i>.</p>"""
    timestamp: NotRequired["capo_cloudformation.types.timestamp.Timestamp"]
    """<p>Time the status was updated.</p>"""
    resource_status: NotRequired[
        "capo_cloudformation.types.resource_status.ResourceStatus"
    ]
    """<p>Current status of the resource.</p>"""
    resource_status_reason: NotRequired[
        "capo_cloudformation.types.resource_status_reason.ResourceStatusReason"
    ]
    """<p>Success/failure message associated with the resource.</p>"""
    resource_properties: NotRequired[
        "capo_cloudformation.types.resource_properties.ResourceProperties"
    ]
    """<p>BLOB of the properties used to create the resource.</p>"""
    client_request_token: NotRequired[
        "capo_cloudformation.types.client_request_token.ClientRequestToken"
    ]
    """<p>The token passed to the operation that generated this event.</p> <p>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 <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>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 <i>Console-StackOperation-ID</i>, 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: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>.</p>"""
    hook_type: NotRequired["capo_cloudformation.types.hook_type.HookType"]
    """<p>The name of the Hook.</p>"""
    hook_status: NotRequired["capo_cloudformation.types.hook_status.HookStatus"]
    """<p>Provides the status of the change set Hook.</p>"""
    hook_status_reason: NotRequired[
        "capo_cloudformation.types.hook_status_reason.HookStatusReason"
    ]
    """<p>Provides the reason for the Hook status.</p>"""
    hook_invocation_point: NotRequired[
        "capo_cloudformation.types.hook_invocation_point.HookInvocationPoint"
    ]
    """<p>The specific point in the provisioning process where the Hook is invoked.</p>"""
    hook_invocation_id: NotRequired[
        "capo_cloudformation.types.hook_invocation_id.HookInvocationId"
    ]
    """<p>The unique identifier of the Hook invocation.</p>"""
    hook_failure_mode: NotRequired[
        "capo_cloudformation.types.hook_failure_mode.HookFailureMode"
    ]
    """<p>Specify the Hook failure mode for non-compliant resources in the followings ways.</p> <ul> <li> <p> <code>FAIL</code> Stops provisioning resources.</p> </li> <li> <p> <code>WARN</code> Allows provisioning to continue with a warning message.</p> </li> </ul>"""
    detailed_status: NotRequired[
        "capo_cloudformation.types.detailed_status.DetailedStatus"
    ]
    """<p>An optional field that contains information about the detailed status of the stack event.</p> <ul> <li> <p> <code>CONFIGURATION_COMPLETE</code> - all of the resources in the stack have reached that event. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html">Understand CloudFormation stack creation events</a> in the <i>CloudFormation User Guide</i>.</p> </li> </ul> <ul> <li> <p> <code>VALIDATION_FAILED</code> - template validation failed because of invalid properties in the template. The <code>ResourceStatusReason</code> field shows what properties are defined incorrectly.</p> </li> </ul>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

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 instance-attribute

detailed_status: NotRequired[DetailedStatus]

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

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

event_id instance-attribute

event_id: NotRequired[EventId]

The unique identifier of this event.

hook_failure_mode instance-attribute

hook_failure_mode: NotRequired[HookFailureMode]

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 instance-attribute

hook_invocation_id: NotRequired[HookInvocationId]

The unique identifier of the Hook invocation.

hook_invocation_point instance-attribute

hook_invocation_point: NotRequired[HookInvocationPoint]

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

hook_status instance-attribute

hook_status: NotRequired[HookStatus]

Provides the status of the change set Hook.

hook_status_reason instance-attribute

hook_status_reason: NotRequired[HookStatusReason]

Provides the reason for the Hook status.

hook_type instance-attribute

hook_type: NotRequired[HookType]

The name of the Hook.

logical_resource_id instance-attribute

logical_resource_id: NotRequired[LogicalResourceId]

The logical name of the resource specified in the template.

operation_id instance-attribute

operation_id: NotRequired[OperationId]

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

physical_resource_id instance-attribute

physical_resource_id: NotRequired[PhysicalResourceId]

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

resource_properties instance-attribute

resource_properties: NotRequired[ResourceProperties]

BLOB of the properties used to create the resource.

resource_status instance-attribute

resource_status: NotRequired[ResourceStatus]

Current status of the resource.

resource_status_reason instance-attribute

resource_status_reason: NotRequired[ResourceStatusReason]

Success/failure message associated with the resource.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

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

stack_id instance-attribute

stack_id: NotRequired[StackId]

The unique ID name of the instance of the stack.

stack_name instance-attribute

stack_name: NotRequired[StackName]

The name associated with a stack.

timestamp instance-attribute

timestamp: NotRequired[Timestamp]

Time the status was updated.