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	awscc.cloudformation.hook_type_configs

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
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.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	hook_type_configs	INSERT	region
delete_resource	hook_type_configs	DELETE	Identifier, region
update_resource	hook_type_configs	UPDATE	Identifier, PatchDocument, region
list_resources	hook_type_configs_list_only	SELECT	region
get_resource	hook_type_configs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual hook_type_config.

SELECT
  region,
  type_arn,
  type_name,
  configuration_arn,
  configuration,
  configuration_alias
FROM awscc.cloudformation.hook_type_configs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ configuration_arn }}';

list (identifiers only)

Lists all hook_type_configs in a region.

SELECT
  region,
  configuration_arn
FROM awscc.cloudformation.hook_type_configs_list_only
WHERE
  region = '{{ region }}';

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 awscc.cloudformation.hook_type_configs (
  TypeArn,
  TypeName,
  Configuration,
  ConfigurationAlias,
  region
)
SELECT
  '{{ type_arn }}',
  '{{ type_name }}',
  '{{ configuration }}',
  '{{ configuration_alias }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudformation.hook_type_configs (
  TypeArn,
  TypeName,
  Configuration,
  ConfigurationAlias,
  region
)
SELECT
  '{{ type_arn }}',
  '{{ type_name }}',
  '{{ configuration }}',
  '{{ configuration_alias }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: type_arn
      value: '{{ type_arn }}'
    - name: type_name
      value: '{{ type_name }}'
    - name: configuration
      value: '{{ configuration }}'
    - name: configuration_alias
      value: '{{ configuration_alias }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cloudformation.hook_type_configs
SET PatchDocument = string('{{ {
    "TypeArn": type_arn,
    "TypeName": type_name,
    "Configuration": configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ configuration_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cloudformation.hook_type_configs
WHERE
  Identifier = '{{ configuration_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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