Skip to content

ChangeSetHook

Source code in docs_src/capo_cloudformation/types/change_set_hook.py
class ChangeSetHook(TypedDict, closed=True):
    invocation_point: NotRequired[
        "capo_cloudformation.types.hook_invocation_point.HookInvocationPoint"
    ]
    """<p>The specific point in the provisioning process where the Hook is invoked.</p>"""
    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>"""
    type_name: NotRequired["capo_cloudformation.types.hook_type_name.HookTypeName"]
    """<p>The unique name for your Hook. Specifies a three-part namespace for your Hook, with a recommended pattern of <code>Organization::Service::Hook</code>.</p> <note> <p>The following organization namespaces are reserved and can't be used in your Hook type names:</p> <ul> <li> <p> <code>Alexa</code> </p> </li> <li> <p> <code>AMZN</code> </p> </li> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>ASK</code> </p> </li> <li> <p> <code>AWS</code> </p> </li> <li> <p> <code>Custom</code> </p> </li> <li> <p> <code>Dev</code> </p> </li> </ul> </note>"""
    type_version_id: NotRequired[
        "capo_cloudformation.types.hook_type_version_id.HookTypeVersionId"
    ]
    """<p>The version ID of the type specified.</p>"""
    type_configuration_version_id: NotRequired[
        "capo_cloudformation.types.hook_type_configuration_version_id.HookTypeConfigurationVersionId"
    ]
    """<p>The version ID of the type configuration.</p>"""
    target_details: NotRequired[
        "capo_cloudformation.types.change_set_hook_target_details.ChangeSetHookTargetDetails"
    ]
    """<p>Specifies details about the target that the Hook will run against.</p>"""

failure_mode instance-attribute

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.

invocation_point instance-attribute

invocation_point: NotRequired[HookInvocationPoint]

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

target_details instance-attribute

target_details: NotRequired[ChangeSetHookTargetDetails]

Specifies details about the target that the Hook will run against.

type_configuration_version_id instance-attribute

type_configuration_version_id: NotRequired[HookTypeConfigurationVersionId]

The version ID of the type configuration.

type_name instance-attribute

type_name: NotRequired[HookTypeName]

The unique name for your Hook. Specifies a three-part namespace for your Hook, with a recommended pattern of Organization::Service::Hook.

The following organization namespaces are reserved and can't be used in your Hook type names:

  • Alexa

  • AMZN

  • Amazon

  • ASK

  • AWS

  • Custom

  • Dev

type_version_id instance-attribute

type_version_id: NotRequired[HookTypeVersionId]

The version ID of the type specified.