HookProgressEvent

Represents the current status of a Hook operation request for the target resource.

For more information on Hooks, see Creating and Managing AWS CloudFormation Hooks.

FailureMode

The failure mode of the invocation. The following are the potential statuses:

FAIL: This will fail the Hook invocation and the request associated with it.
WARN: This will fail the Hook invocation, but not the request associated with it.

Type: String

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

Pattern: [-A-Za-z_]+

Required: No

HookEventTime

The time that the Hook invocation request initiated.

Type: Timestamp

Required: No

HookStatus

The status of the Hook invocation. The following are potential statuses:

HOOK_PENDING: The Hook was added to the invocation plan, but not yet invoked.
HOOK_IN_PROGRESS: The Hook was invoked, but hasn't completed.
HOOK_COMPLETE_SUCCEEDED: The Hook invocation is complete with a successful result.
HOOK_COMPLETE_FAILED: The Hook invocation is complete with a failed result.
HOOK_FAILED: The Hook invocation didn't complete successfully.

Type: String

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

Pattern: [-A-Za-z_]+

Required: No

HookStatusMessage

The message explaining the current Hook status.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: [\s\S]*

Required: No

HookTypeArn

The ARN of the Hook being invoked.

Type: String

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

Pattern: arn:aws.*:.+:.*:.*:.+

Required: No

HookTypeName

The type name of the Hook being invoked.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 196.

Pattern: [A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}

Required: No

HookTypeVersionId

The type version of the Hook being invoked.

Type: String

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

Pattern: [A-Za-z0-9-]+

Required: No

InvocationPoint

The point in which the Hook is being invoked.

Type: String

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

Pattern: [-A-Za-z_]+

Required: No

HookProgressEvent

Contents

See Also