hook_default_versions

Creates, updates, deletes or gets a hook_default_version resource or lists hook_default_versions in a region

Overview

Name	hook_default_versions
Type	Resource
Description	Set a version as default version for a hook in CloudFormation Registry.
Id	aws.cloudformation.hook_default_versions

Fields

Name	Datatype	Description
type_version_arn	string	The Amazon Resource Name (ARN) of the type version.
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.
arn	string	The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
version_id	string	The ID of an existing version of the hook to set as the default.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all hook_default_versions in a region.

SELECT
region,
type_version_arn,
type_name,
arn,
version_id
FROM aws.cloudformation.hook_default_versions
WHERE region = 'us-east-1';

Gets all properties from an individual hook_default_version.

SELECT
region,
type_version_arn,
type_name,
arn,
version_id
FROM aws.cloudformation.hook_default_versions
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.cloudformation.hook_default_versions (
 TypeVersionArn,
 TypeName,
 VersionId,
 region
)
SELECT 
'{{ TypeVersionArn }}',
 '{{ TypeName }}',
 '{{ VersionId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cloudformation.hook_default_versions (
 TypeVersionArn,
 TypeName,
 VersionId,
 region
)
SELECT 
 '{{ TypeVersionArn }}',
 '{{ TypeName }}',
 '{{ VersionId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: hook_default_version
    props:
      - name: TypeVersionArn
        value: '{{ TypeVersionArn }}'
      - name: TypeName
        value: '{{ TypeName }}'
      - name: VersionId
        value: '{{ VersionId }}'

Permissions

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

Create

cloudformation:SetTypeDefaultVersion

Read

cloudformation:DescribeType

Update

cloudformation:SetTypeDefaultVersion

List

cloudformation:ListTypes