HookResultSummary - Amazon CloudFormation
ContentsSee Also
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 (PDF).

HookResultSummary

Describes a Hook invocation, its status, and the reason for its status.

Contents

FailureMode

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

  • FAIL: If the hook invocation returns a failure, then the requested target operation should fail.

  • WARN: If the hook invocation returns a failure, then the requested target operation should warn.

Type: String

Valid Values: FAIL | WARN

Required: No

HookStatusReason

A description of the Hook results status. For example, if the Hook result is in a FAILED state, this may contain additional information for the FAILED state.

Type: String

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

Required: No

InvocationPoint

The exact point in the provisioning logic where the Hook runs.

Type: String

Valid Values: PRE_PROVISION

Required: No

Status

The state of the Hook invocation.

Type: String

Valid Values: HOOK_IN_PROGRESS | HOOK_COMPLETE_SUCCEEDED | HOOK_COMPLETE_FAILED | HOOK_FAILED

Required: No

TypeConfigurationVersionId

The version of the Hook type configuration.

Type: String

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

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

Required: No

TypeName

The type name of the Hook being invoked.

Type: String

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

Required: No

TypeVersionId

The 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

See Also

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