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

Fields

get (all properties)

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.

list (identifiers only)

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

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual resource_default_version.

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

list (identifiers only)

Lists all resource_default_versions in a region.

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

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

All Properties

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

UPDATE example

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

/*+ update */
UPDATE awscc.cloudformation.resource_default_versions
SET PatchDocument = string('{{ {
    "VersionId": version_id,
    "TypeName": type_name,
    "TypeVersionArn": type_version_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cloudformation.resource_default_versions
WHERE
  Identifier = '{{ 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 resource_default_versions resource, the following permissions are required:

Read

cloudformation:DescribeType

Create

cloudformation:SetTypeDefaultVersion

Update

cloudformation:SetTypeDefaultVersion

List

cloudformation:ListTypeVersions

Delete