lambda_hooks

Creates, updates, deletes or gets a lambda_hook resource or lists lambda_hooks in a region

Overview

Name	lambda_hooks
Type	Resource
Description	This is a CloudFormation resource for the first-party AWS::Hooks::LambdaHook.
Id	aws.cloudformation.lambda_hooks

Fields

Name	Datatype	Description
lambda_function	string	Amazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
hook_status	string	Attribute to specify which stacks this hook applies to or should get invoked for
target_operations	array	Which operations should this Hook run against? Resource changes, stacks or change sets.
failure_mode	string	Attribute to specify CloudFormation behavior on hook failure.
target_filters	object	Attribute to specify which targets should invoke the hook
stack_filters	object	Filters to allow hooks to target specific stack attributes
alias	string	The typename alias for the hook.
hook_arn	string	The Amazon Resource Name (ARN) of the activated hook
execution_role	string	The execution role ARN assumed by Hooks to invoke Lambda.
region	string	AWS region.

For more information, see AWS::CloudFormation::LambdaHook.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	LambdaFunction, FailureMode, Alias, ExecutionRole, TargetOperations, HookStatus, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all lambda_hooks in a region.

SELECT
region,
lambda_function,
hook_status,
target_operations,
failure_mode,
target_filters,
stack_filters,
alias,
hook_arn,
execution_role
FROM aws.cloudformation.lambda_hooks
WHERE region = 'us-east-1';

Gets all properties from an individual lambda_hook.

SELECT
region,
lambda_function,
hook_status,
target_operations,
failure_mode,
target_filters,
stack_filters,
alias,
hook_arn,
execution_role
FROM aws.cloudformation.lambda_hooks
WHERE region = 'us-east-1' AND data__Identifier = '<HookArn>';

INSERT example

Use the following StackQL query and manifest file to create a new lambda_hook resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.cloudformation.lambda_hooks (
 LambdaFunction,
 HookStatus,
 TargetOperations,
 FailureMode,
 Alias,
 ExecutionRole,
 region
)
SELECT 
'{{ LambdaFunction }}',
 '{{ HookStatus }}',
 '{{ TargetOperations }}',
 '{{ FailureMode }}',
 '{{ Alias }}',
 '{{ ExecutionRole }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cloudformation.lambda_hooks (
 LambdaFunction,
 HookStatus,
 TargetOperations,
 FailureMode,
 TargetFilters,
 StackFilters,
 Alias,
 ExecutionRole,
 region
)
SELECT 
 '{{ LambdaFunction }}',
 '{{ HookStatus }}',
 '{{ TargetOperations }}',
 '{{ FailureMode }}',
 '{{ TargetFilters }}',
 '{{ StackFilters }}',
 '{{ Alias }}',
 '{{ ExecutionRole }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: lambda_hook
    props:
      - name: LambdaFunction
        value: '{{ LambdaFunction }}'
      - name: HookStatus
        value: '{{ HookStatus }}'
      - name: TargetOperations
        value:
          - '{{ TargetOperations[0] }}'
      - name: FailureMode
        value: '{{ FailureMode }}'
      - name: TargetFilters
        value: {}
      - name: StackFilters
        value:
          FilteringCriteria: '{{ FilteringCriteria }}'
          StackNames:
            Include:
              - '{{ Include[0] }}'
            Exclude:
              - null
          StackRoles:
            Include:
              - '{{ Include[0] }}'
            Exclude:
              - null
      - name: Alias
        value: '{{ Alias }}'
      - name: ExecutionRole
        value: null

DELETE example

/*+ delete */
DELETE FROM aws.cloudformation.lambda_hooks
WHERE data__Identifier = '<HookArn>'
AND region = 'us-east-1';

Permissions

To operate on the lambda_hooks resource, the following permissions are required:

Create

cloudformation:ListTypes,
cloudformation:ActivateType,
cloudformation:BatchDescribeTypeConfigurations,
cloudformation:DescribeType,
cloudformation:SetTypeConfiguration,
iam:PassRole

Read

cloudformation:BatchDescribeTypeConfigurations,
cloudformation:DescribeType

Update

cloudformation:BatchDescribeTypeConfigurations,
cloudformation:DescribeType,
cloudformation:SetTypeConfiguration,
iam:PassRole

Delete

cloudformation:BatchDescribeTypeConfigurations,
cloudformation:DeactivateType,
cloudformation:DescribeType,
cloudformation:SetTypeConfiguration

List

cloudformation:ListTypes,
cloudformation:BatchDescribeTypeConfigurations,
cloudformation:DescribeType