1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cloudformation
  5. getLambdaHook

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.cloudformation.getLambdaHook

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

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

    Using getLambdaHook

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLambdaHook(args: GetLambdaHookArgs, opts?: InvokeOptions): Promise<GetLambdaHookResult>
    function getLambdaHookOutput(args: GetLambdaHookOutputArgs, opts?: InvokeOptions): Output<GetLambdaHookResult>
    def get_lambda_hook(hook_arn: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetLambdaHookResult
    def get_lambda_hook_output(hook_arn: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetLambdaHookResult]
    func LookupLambdaHook(ctx *Context, args *LookupLambdaHookArgs, opts ...InvokeOption) (*LookupLambdaHookResult, error)
    func LookupLambdaHookOutput(ctx *Context, args *LookupLambdaHookOutputArgs, opts ...InvokeOption) LookupLambdaHookResultOutput

    > Note: This function is named LookupLambdaHook in the Go SDK.

    public static class GetLambdaHook 
    {
        public static Task<GetLambdaHookResult> InvokeAsync(GetLambdaHookArgs args, InvokeOptions? opts = null)
        public static Output<GetLambdaHookResult> Invoke(GetLambdaHookInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLambdaHookResult> getLambdaHook(GetLambdaHookArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:cloudformation:getLambdaHook
      arguments:
        # arguments dictionary

    The following arguments are supported:

    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook
    hookArn string
    The Amazon Resource Name (ARN) of the activated hook
    hook_arn str
    The Amazon Resource Name (ARN) of the activated hook
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook

    getLambdaHook Result

    The following output properties are available:

    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.
    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    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.
    StackFilters Pulumi.AwsNative.CloudFormation.Outputs.StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    TargetFilters Pulumi.AwsNative.CloudFormation.Outputs.TargetFilters0Properties | Pulumi.AwsNative.CloudFormation.Outputs.TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    TargetOperations List<Pulumi.AwsNative.CloudFormation.LambdaHookTargetOperation>
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    ExecutionRole string
    The execution role ARN assumed by Hooks to invoke Lambda.
    FailureMode LambdaHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    HookArn string
    The Amazon Resource Name (ARN) of the activated hook
    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.
    StackFilters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    TargetFilters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    TargetOperations []LambdaHookTargetOperation
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    executionRole String
    The execution role ARN assumed by Hooks to invoke Lambda.
    failureMode LambdaHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook
    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.
    stackFilters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    targetFilters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    targetOperations List<LambdaHookTargetOperation>
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    executionRole string
    The execution role ARN assumed by Hooks to invoke Lambda.
    failureMode LambdaHookFailureMode
    Attribute to specify CloudFormation behavior on hook failure.
    hookArn string
    The Amazon Resource Name (ARN) of the activated hook
    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.
    stackFilters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    targetFilters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    targetOperations LambdaHookTargetOperation[]
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    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_arn str
    The Amazon Resource Name (ARN) of the activated hook
    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.
    stack_filters StackFiltersProperties
    Filters to allow hooks to target specific stack attributes
    target_filters TargetFilters0Properties | TargetFilters1Properties
    Attribute to specify which targets should invoke the hook
    target_operations Sequence[LambdaHookTargetOperation]
    Which operations should this Hook run against? Resource changes, stacks or change sets.
    executionRole String
    The execution role ARN assumed by Hooks to invoke Lambda.
    failureMode "FAIL" | "WARN"
    Attribute to specify CloudFormation behavior on hook failure.
    hookArn String
    The Amazon Resource Name (ARN) of the activated hook
    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.
    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
    targetOperations List<"RESOURCE" | "STACK" | "CHANGE_SET">
    Which operations should this Hook run against? Resource changes, stacks or change sets.

    Supporting Types

    LambdaHookAction

    LambdaHookFailureMode

    LambdaHookHookStatus

    LambdaHookHookTarget

    LambdaHookInvocationPoint

    LambdaHookStackFiltersPropertiesFilteringCriteria

    LambdaHookTargetOperation

    StackFiltersProperties

    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

    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

    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

    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

    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.9.0 published on Monday, Nov 18, 2024 by Pulumi