Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudformation
  5. LambdaHook

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudformation.LambdaHook

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    This is a CloudFormation resource for the first-party AWS::Hooks::LambdaHook.

    Create LambdaHook Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LambdaHook(name: string, args: LambdaHookArgs, opts?: CustomResourceOptions);
    @overload
def LambdaHook(resource_name: str,
               args: LambdaHookArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def LambdaHook(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               alias: Optional[str] = None,
               execution_role: Optional[str] = None,
               failure_mode: Optional[LambdaHookFailureMode] = None,
               hook_status: Optional[LambdaHookHookStatus] = None,
               lambda_function: Optional[str] = None,
               target_operations: Optional[Sequence[LambdaHookTargetOperation]] = None,
               stack_filters: Optional[StackFiltersPropertiesArgs] = None,
               target_filters: Optional[Union[TargetFilters0PropertiesArgs, TargetFilters1PropertiesArgs]] = None)
    func NewLambdaHook(ctx *Context, name string, args LambdaHookArgs, opts ...ResourceOption) (*LambdaHook, error)
    public LambdaHook(string name, LambdaHookArgs args, CustomResourceOptions? opts = null)
    public LambdaHook(String name, LambdaHookArgs args)
public LambdaHook(String name, LambdaHookArgs args, CustomResourceOptions options)

    type: aws-native:cloudformation:LambdaHook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args LambdaHookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args LambdaHookArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args LambdaHookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LambdaHookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LambdaHookArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    LambdaHook Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LambdaHook resource accepts the following input properties:

    Alias string
    The typename alias for the hook.
    ExecutionRole string
    The execution role ARN assumed by Hooks to invoke Lambda.
    FailureMode Pulumi.AwsNative.CloudFormation.LambdaHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    HookStatus Pulumi.AwsNative.CloudFormation.LambdaHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    LambdaFunction string
    Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
    TargetOperations List<Pulumi.AwsNative.CloudFormation.LambdaHookTargetOperation>
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    StackFilters Pulumi.AwsNative.CloudFormation.Inputs.StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    TargetFilters Pulumi.AwsNative.CloudFormation.Inputs.TargetFilters0Properties | Pulumi.AwsNative.CloudFormation.Inputs.TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    Alias string
    The typename alias for the hook.
    ExecutionRole string
    The execution role ARN assumed by Hooks to invoke Lambda.
    FailureMode LambdaHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    HookStatus LambdaHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    LambdaFunction string
    Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
    TargetOperations []LambdaHookTargetOperation
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    StackFilters StackFiltersPropertiesArgs
    Filters to allow hooks to target specific stack attributes
    TargetFilters TargetFilters0PropertiesArgs | TargetFilters1PropertiesArgs
    Attribute to specify which targets should invoke the hook
    alias String
    The typename alias for the hook.
    executionRole String
    The execution role ARN assumed by Hooks to invoke Lambda.
    failureMode LambdaHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    hookStatus LambdaHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    lambdaFunction String
    Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
    targetOperations List<LambdaHookTargetOperation>
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    stackFilters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    targetFilters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    alias string
    The typename alias for the hook.
    executionRole string
    The execution role ARN assumed by Hooks to invoke Lambda.
    failureMode LambdaHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    hookStatus LambdaHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    lambdaFunction string
    Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
    targetOperations LambdaHookTargetOperation[]
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    stackFilters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    targetFilters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    alias str
    The typename alias for the hook.
    execution_role str
    The execution role ARN assumed by Hooks to invoke Lambda.
    failure_mode LambdaHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    hook_status LambdaHookHookStatus
    Attribute to specify which stacks this hook applies to or should get invoked for
    lambda_function str
    Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
    target_operations Sequence[LambdaHookTargetOperation]
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    stack_filters StackFiltersPropertiesArgs
    Filters to allow hooks to target specific stack attributes
    target_filters TargetFilters0PropertiesArgs | TargetFilters1PropertiesArgs
    Attribute to specify which targets should invoke the hook
    alias String
    The typename alias for the hook.
    executionRole String
    The execution role ARN assumed by Hooks to invoke Lambda.
    failureMode "FAIL" | "WARN"
    Attribute to specify CloudFormation behavior on hook failure.
    hookStatus "ENABLED" | "DISABLED"
    Attribute to specify which stacks this hook applies to or should get invoked for
    lambdaFunction String
    Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
    targetOperations List<"RESOURCE" | "STACK" | "CHANGE_SET" | "CLOUD_CONTROL">
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    stackFilters Property Map
    Filters to allow hooks to target specific stack attributes
    targetFilters Property Map | Property Map
    Attribute to specify which targets should invoke the hook

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LambdaHook resource produces the following output properties:

    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    Id string
    The provider-assigned unique ID for this managed resource.
    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    Id string
    The provider-assigned unique ID for this managed resource.
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook
    id String
    The provider-assigned unique ID for this managed resource.
    hookArn string
    The Amazon Resource Name (ARN) of the activated hook
    id string
    The provider-assigned unique ID for this managed resource.
    hook_arn str
    The Amazon Resource Name (ARN) of the activated hook
    id str
    The provider-assigned unique ID for this managed resource.
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    LambdaHookAction, LambdaHookActionArgs

    Create
    CREATE
    Update
    UPDATE
    Delete
    DELETE
    LambdaHookActionCreate
    CREATE
    LambdaHookActionUpdate
    UPDATE
    LambdaHookActionDelete
    DELETE
    Create
    CREATE
    Update
    UPDATE
    Delete
    DELETE
    Create
    CREATE
    Update
    UPDATE
    Delete
    DELETE
    CREATE
    CREATE
    UPDATE
    UPDATE
    DELETE
    DELETE
    "CREATE"
    CREATE
    "UPDATE"
    UPDATE
    "DELETE"
    DELETE

    LambdaHookFailureMode, LambdaHookFailureModeArgs

    Fail
    FAIL
    Warn
    WARN
    LambdaHookFailureModeFail
    FAIL
    LambdaHookFailureModeWarn
    WARN
    Fail
    FAIL
    Warn
    WARN
    Fail
    FAIL
    Warn
    WARN
    FAIL
    FAIL
    WARN
    WARN
    "FAIL"
    FAIL
    "WARN"
    WARN

    LambdaHookHookStatus, LambdaHookHookStatusArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    LambdaHookHookStatusEnabled
    ENABLED
    LambdaHookHookStatusDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    LambdaHookHookTarget, LambdaHookHookTargetArgs

    LambdaHookInvocationPoint, LambdaHookInvocationPointArgs

    PreProvision
    PRE_PROVISION
    LambdaHookInvocationPointPreProvision
    PRE_PROVISION
    PreProvision
    PRE_PROVISION
    PreProvision
    PRE_PROVISION
    PRE_PROVISION
    PRE_PROVISION
    "PRE_PROVISION"
    PRE_PROVISION

    LambdaHookStackFiltersPropertiesFilteringCriteria, LambdaHookStackFiltersPropertiesFilteringCriteriaArgs

    All
    ALL
    Any
    ANY
    LambdaHookStackFiltersPropertiesFilteringCriteriaAll
    ALL
    LambdaHookStackFiltersPropertiesFilteringCriteriaAny
    ANY
    All
    ALL
    Any
    ANY
    All
    ALL
    Any
    ANY
    ALL
    ALL
    ANY
    ANY
    "ALL"
    ALL
    "ANY"
    ANY

    LambdaHookTargetOperation, LambdaHookTargetOperationArgs

    Resource
    RESOURCE
    Stack
    STACK
    ChangeSet
    CHANGE_SET
    CloudControl
    CLOUD_CONTROL
    LambdaHookTargetOperationResource
    RESOURCE
    LambdaHookTargetOperationStack
    STACK
    LambdaHookTargetOperationChangeSet
    CHANGE_SET
    LambdaHookTargetOperationCloudControl
    CLOUD_CONTROL
    Resource
    RESOURCE
    Stack
    STACK
    ChangeSet
    CHANGE_SET
    CloudControl
    CLOUD_CONTROL
    Resource
    RESOURCE
    Stack
    STACK
    ChangeSet
    CHANGE_SET
    CloudControl
    CLOUD_CONTROL
    RESOURCE
    RESOURCE
    STACK
    STACK
    CHANGE_SET
    CHANGE_SET
    CLOUD_CONTROL
    CLOUD_CONTROL
    "RESOURCE"
    RESOURCE
    "STACK"
    STACK
    "CHANGE_SET"
    CHANGE_SET
    "CLOUD_CONTROL"
    CLOUD_CONTROL

    StackFiltersProperties, StackFiltersPropertiesArgs

    FilteringCriteria Pulumi.AwsNative.CloudFormation.LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    StackNames Pulumi.AwsNative.CloudFormation.Inputs.StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    StackRoles Pulumi.AwsNative.CloudFormation.Inputs.StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    FilteringCriteria LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    StackNames StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    StackRoles StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    filteringCriteria LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    stackNames StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    stackRoles StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    filteringCriteria LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    stackNames StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    stackRoles StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    filtering_criteria LambdaHookStackFiltersPropertiesFilteringCriteria
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    stack_names StackFiltersPropertiesStackNamesProperties
    List of stack names as filters
    stack_roles StackFiltersPropertiesStackRolesProperties
    List of stack roles that are performing the stack operations.
    filteringCriteria "ALL" | "ANY"
    Attribute to specify the filtering behavior. ANY will make the Hook pass if one filter matches. ALL will make the Hook pass if all filters match
    stackNames Property Map
    List of stack names as filters
    stackRoles Property Map
    List of stack roles that are performing the stack operations.

    StackFiltersPropertiesStackNamesProperties, StackFiltersPropertiesStackNamesPropertiesArgs

    Exclude List<string>
    List of stack names that the hook is going to be excluded from
    Include List<string>
    List of stack names that the hook is going to target
    Exclude []string
    List of stack names that the hook is going to be excluded from
    Include []string
    List of stack names that the hook is going to target
    exclude List<String>
    List of stack names that the hook is going to be excluded from
    include List<String>
    List of stack names that the hook is going to target
    exclude string[]
    List of stack names that the hook is going to be excluded from
    include string[]
    List of stack names that the hook is going to target
    exclude Sequence[str]
    List of stack names that the hook is going to be excluded from
    include Sequence[str]
    List of stack names that the hook is going to target
    exclude List<String>
    List of stack names that the hook is going to be excluded from
    include List<String>
    List of stack names that the hook is going to target

    StackFiltersPropertiesStackRolesProperties, StackFiltersPropertiesStackRolesPropertiesArgs

    Exclude List<string>
    List of stack roles that the hook is going to be excluded from
    Include List<string>
    List of stack roles that the hook is going to target
    Exclude []string
    List of stack roles that the hook is going to be excluded from
    Include []string
    List of stack roles that the hook is going to target
    exclude List<String>
    List of stack roles that the hook is going to be excluded from
    include List<String>
    List of stack roles that the hook is going to target
    exclude string[]
    List of stack roles that the hook is going to be excluded from
    include string[]
    List of stack roles that the hook is going to target
    exclude Sequence[str]
    List of stack roles that the hook is going to be excluded from
    include Sequence[str]
    List of stack roles that the hook is going to target
    exclude List<String>
    List of stack roles that the hook is going to be excluded from
    include List<String>
    List of stack roles that the hook is going to target

    TargetFilters0Properties, TargetFilters0PropertiesArgs

    Actions List<Pulumi.AwsNative.CloudFormation.LambdaHookAction>
    List of actions that the hook is going to target
    InvocationPoints List<Pulumi.AwsNative.CloudFormation.LambdaHookInvocationPoint>
    List of invocation points that the hook is going to target
    TargetNames List<string>
    List of type names that the hook is going to target
    Actions []LambdaHookAction
    List of actions that the hook is going to target
    InvocationPoints []LambdaHookInvocationPoint
    List of invocation points that the hook is going to target
    TargetNames []string
    List of type names that the hook is going to target
    actions List<LambdaHookAction>
    List of actions that the hook is going to target
    invocationPoints List<LambdaHookInvocationPoint>
    List of invocation points that the hook is going to target
    targetNames List<String>
    List of type names that the hook is going to target
    actions LambdaHookAction[]
    List of actions that the hook is going to target
    invocationPoints LambdaHookInvocationPoint[]
    List of invocation points that the hook is going to target
    targetNames string[]
    List of type names that the hook is going to target
    actions Sequence[LambdaHookAction]
    List of actions that the hook is going to target
    invocation_points Sequence[LambdaHookInvocationPoint]
    List of invocation points that the hook is going to target
    target_names Sequence[str]
    List of type names that the hook is going to target
    actions List<"CREATE" | "UPDATE" | "DELETE">
    List of actions that the hook is going to target
    invocationPoints List<"PRE_PROVISION">
    List of invocation points that the hook is going to target
    targetNames List<String>
    List of type names that the hook is going to target

    TargetFilters1Properties, TargetFilters1PropertiesArgs

    Targets []LambdaHookHookTarget
    List of hook targets
    targets LambdaHookHookTarget[]
    List of hook targets
    targets List<Property Map>
    List of hook targets

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native