StackEvent - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

StackEvent

The StackEvent data type.

Contents

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][-a-zA-Z0-9]*

Required: No

EventId

The unique ID of this event.

Type: String

Required: Yes

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.

Type: String

Valid Values: FAIL | WARN

Required: No

HookInvocationPoint

Invocation points are points in provisioning logic where hooks are initiated.

Type: String

Valid Values: PRE_PROVISION

Required: No

HookStatus

Provides the status of the change set hook.

Type: String

Valid Values: HOOK_IN_PROGRESS | HOOK_COMPLETE_SUCCEEDED | HOOK_COMPLETE_FAILED | HOOK_FAILED

Required: No

HookStatusReason

Provides the reason for the hook status.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

HookType

The name of the hook.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

LogicalResourceId

The logical name of the resource specified in the template.

Type: String

Required: No

PhysicalResourceId

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

Type: String

Required: No

ResourceProperties

BLOB of the properties used to create the resource.

Type: String

Required: No

ResourceStatus

Current status of the resource.

Type: String

Valid Values: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | DELETE_SKIPPED | UPDATE_IN_PROGRESS | UPDATE_FAILED | UPDATE_COMPLETE | IMPORT_FAILED | IMPORT_COMPLETE | IMPORT_IN_PROGRESS | IMPORT_ROLLBACK_IN_PROGRESS | IMPORT_ROLLBACK_FAILED | IMPORT_ROLLBACK_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE | UPDATE_ROLLBACK_FAILED | ROLLBACK_IN_PROGRESS | ROLLBACK_COMPLETE | ROLLBACK_FAILED

Required: No

ResourceStatusReason

Success/failure message associated with the resource.

Type: String

Required: No

ResourceType

Type of resource. (For more information, go to Amazon Resource Types Reference in the Amazon CloudFormation User Guide.)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

StackId

The unique ID name of the instance of the stack.

Type: String

Required: Yes

StackName

The name associated with a stack.

Type: String

Required: Yes

Timestamp

Time the status was updated.

Type: Timestamp

Required: Yes

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: