CfnLambdaHookProps

class aws_cdk.aws_cloudformation.CfnLambdaHookProps(*, alias, execution_role, failure_mode, hook_status, lambda_function, target_operations, stack_filters=None, target_filters=None)

Bases: object

Properties for defining a CfnLambdaHook.

Parameters:

alias (str) – The type name alias for the Hook. This alias must be unique per account and Region. The alias must be in the form Name1::Name2::Name3 and must not begin with AWS . For example, Private::Lambda::MyTestHook .
execution_role (str) – The IAM role that the Hook assumes to invoke your Lambda function.
failure_mode (str) – Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response. - FAIL : Prevents the action from proceeding. This is helpful for enforcing strict compliance or security policies. - WARN : Issues warnings to users but allows actions to continue. This is useful for non-critical validations or informational checks.
hook_status (str) – Specifies if the Hook is ENABLED or DISABLED . Default: - “ENABLED”
lambda_function (str) – Specifies the Lambda function for the Hook. You can use:. - The full Amazon Resource Name (ARN) without a suffix. - A qualified ARN with a version or alias suffix.
target_operations (Sequence[str]) – Specifies the list of operations the Hook is run against. For more information, see Hook targets in the AWS CloudFormation Hooks User Guide . Valid values: STACK | RESOURCE | CHANGE_SET | CLOUD_CONTROL
stack_filters (Union[IResolvable, StackFiltersProperty, Dict[str, Any], None]) – Specifies the stack level filters for the Hook. Example stack level filter in JSON: "StackFilters": {"FilteringCriteria": "ALL", "StackNames": {"Exclude": [ "stack-1", "stack-2"]}} Example stack level filter in YAML: StackFilters: FilteringCriteria: ALL StackNames: Exclude: - stack-1 - stack-2
target_filters (Union[IResolvable, TargetFiltersProperty, Dict[str, Any], None]) – Specifies the target filters for the Hook. Example target filter in JSON: "TargetFilters": {"Actions": [ "CREATE", "UPDATE", "DELETE" ]} Example target filter in YAML: TargetFilters: Actions: - CREATE - UPDATE - DELETE

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudformation as cloudformation

cfn_lambda_hook_props = cloudformation.CfnLambdaHookProps(
    alias="alias",
    execution_role="executionRole",
    failure_mode="failureMode",
    hook_status="hookStatus",
    lambda_function="lambdaFunction",
    target_operations=["targetOperations"],

    # the properties below are optional
    stack_filters=cloudformation.CfnLambdaHook.StackFiltersProperty(
        filtering_criteria="filteringCriteria",

        # the properties below are optional
        stack_names=cloudformation.CfnLambdaHook.StackNamesProperty(
            exclude=["exclude"],
            include=["include"]
        ),
        stack_roles=cloudformation.CfnLambdaHook.StackRolesProperty(
            exclude=["exclude"],
            include=["include"]
        )
    ),
    target_filters=cloudformation.CfnLambdaHook.TargetFiltersProperty(
        targets=[cloudformation.CfnLambdaHook.HookTargetProperty(
            action="action",
            invocation_point="invocationPoint",
            target_name="targetName"
        )],

        # the properties below are optional
        actions=["actions"],
        invocation_points=["invocationPoints"],
        target_names=["targetNames"]
    )
)

Attributes

alias

The type name alias for the Hook. This alias must be unique per account and Region.

The alias must be in the form Name1::Name2::Name3 and must not begin with AWS . For example, Private::Lambda::MyTestHook .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-alias

execution_role

The IAM role that the Hook assumes to invoke your Lambda function.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-lambdahook.html#cfn-cloudformation-lambdahook-executionrole

failure_mode

Specifies how the Hook responds when the Lambda function invoked by the Hook returns a FAILED response.

FAIL : Prevents the action from proceeding. This is helpful for enforcing strict compliance or security policies.
WARN : Issues warnings to users but allows actions to continue. This is useful for non-critical validations or informational checks.