hook_type_configs

Creates, updates, deletes or gets a hook_type_config resource or lists hook_type_configs in a region

Overview

Name	hook_type_configs
Type	Resource
Description	Specifies the configuration data for a registered hook in CloudFormation Registry.
Id	aws.cloudformation.hook_type_configs

Fields

Name	Datatype	Description
type_arn	string	The Amazon Resource Name (ARN) of the type without version number.
type_name	string	The name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
configuration_arn	string	The Amazon Resource Name (ARN) for the configuration data, in this account and region.
configuration	string	The configuration data for the extension, in this account and region.
configuration_alias	string	An alias by which to refer to this extension configuration data.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	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 hook_type_configs in a region.

SELECT
region,
type_arn,
type_name,
configuration_arn,
configuration,
configuration_alias
FROM aws.cloudformation.hook_type_configs
WHERE region = 'us-east-1';

Gets all properties from an individual hook_type_config.

SELECT
region,
type_arn,
type_name,
configuration_arn,
configuration,
configuration_alias
FROM aws.cloudformation.hook_type_configs
WHERE region = 'us-east-1' AND data__Identifier = '<ConfigurationArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.cloudformation.hook_type_configs (
 TypeArn,
 TypeName,
 Configuration,
 ConfigurationAlias,
 region
)
SELECT 
'{{ TypeArn }}',
 '{{ TypeName }}',
 '{{ Configuration }}',
 '{{ ConfigurationAlias }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cloudformation.hook_type_configs (
 TypeArn,
 TypeName,
 Configuration,
 ConfigurationAlias,
 region
)
SELECT 
 '{{ TypeArn }}',
 '{{ TypeName }}',
 '{{ Configuration }}',
 '{{ ConfigurationAlias }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: hook_type_config
    props:
      - name: TypeArn
        value: '{{ TypeArn }}'
      - name: TypeName
        value: '{{ TypeName }}'
      - name: Configuration
        value: '{{ Configuration }}'
      - name: ConfigurationAlias
        value: '{{ ConfigurationAlias }}'

DELETE example

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

Permissions

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

Create

cloudformation:SetTypeConfiguration

Read

cloudformation:BatchDescribeTypeConfigurations

Update

cloudformation:SetTypeConfiguration

Delete

cloudformation:SetTypeConfiguration

List

cloudformation:ListTypes,
cloudformation:BatchDescribeTypeConfigurations