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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the type. This is used to uniquely identify a HookDefaultVersion
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	hook_default_versions	INSERT	region
update_resource	hook_default_versions	UPDATE	Identifier, PatchDocument, region
list_resources	hook_default_versions_list_only	SELECT	region
get_resource	hook_default_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual hook_default_version.

SELECT
  region,
  type_version_arn,
  type_name,
  arn,
  version_id
FROM awscc.cloudformation.hook_default_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all hook_default_versions in a region.

SELECT
  region,
  arn
FROM awscc.cloudformation.hook_default_versions_list_only
WHERE
  region = '{{ region }}';

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 awscc.cloudformation.hook_default_versions (
  TypeVersionArn,
  TypeName,
  VersionId,
  region
)
SELECT
  '{{ type_version_arn }}',
  '{{ type_name }}',
  '{{ version_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudformation.hook_default_versions (
  TypeVersionArn,
  TypeName,
  VersionId,
  region
)
SELECT
  '{{ type_version_arn }}',
  '{{ type_name }}',
  '{{ version_id }}',
  '{{ 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_default_version
  props:
    - name: type_version_arn
      value: '{{ type_version_arn }}'
    - name: type_name
      value: '{{ type_name }}'
    - name: version_id
      value: '{{ version_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.cloudformation.hook_default_versions
SET PatchDocument = string('{{ {
    "TypeVersionArn": type_version_arn,
    "TypeName": type_name,
    "VersionId": version_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
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_default_versions resource, the following permissions are required:

Create

cloudformation:SetTypeDefaultVersion

Read

cloudformation:DescribeType

Update

cloudformation:SetTypeDefaultVersion

List

cloudformation:ListTypes