resource_default_versions

Creates, updates, deletes or gets a resource_default_version resource or lists resource_default_versions in a region

Overview

Name	resource_default_versions
Type	Resource
Description	The default version of a resource that has been registered in the CloudFormation Registry.
Id	aws.cloudformation.resource_default_versions

Fields

Name	Datatype	Description
version_id	string	The ID of an existing version of the resource to set as the default.
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 ResourceDefaultVersion
type_version_arn	string	The Amazon Resource Name (ARN) of the type version.
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 resource_default_versions in a region.

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

Gets all properties from an individual resource_default_version.

SELECT
region,
version_id,
type_name,
arn,
type_version_arn
FROM aws.cloudformation.resource_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 resource_default_version resource, using stack-deploy.

Required Properties

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

All Properties

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

Manifest

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

DELETE example

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

Permissions

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

Read

cloudformation:DescribeType

Create

cloudformation:SetTypeDefaultVersion

Update

cloudformation:SetTypeDefaultVersion

List

cloudformation:ListTypeVersions

Delete