module_default_versions

Creates, updates, deletes or gets a module_default_version resource or lists module_default_versions in a region

Overview

Name	module_default_versions
Type	Resource
Description	A module that has been registered in the CloudFormation registry as the default version
Id	aws.cloudformation.module_default_versions

Fields

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the module version to set as the default version.
module_name	string	The name of a module existing in the registry.
version_id	string	The ID of an existing version of the named module to set as the default.
region	string	AWS region.

Methods

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

SELECT examples

Gets all module_default_versions in a region.

SELECT
region,
arn,
module_name,
version_id
FROM aws.cloudformation.module_default_versions
WHERE region = 'us-east-1';

Gets all properties from an individual module_default_version.

SELECT
region,
arn,
module_name,
version_id
FROM aws.cloudformation.module_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 module_default_version resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.cloudformation.module_default_versions (
 Arn,
 ModuleName,
 VersionId,
 region
)
SELECT 
'{{ Arn }}',
 '{{ ModuleName }}',
 '{{ VersionId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.cloudformation.module_default_versions (
 Arn,
 ModuleName,
 VersionId,
 region
)
SELECT 
 '{{ Arn }}',
 '{{ ModuleName }}',
 '{{ VersionId }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: module_default_version
    props:
      - name: Arn
        value: '{{ Arn }}'
      - name: ModuleName
        value: '{{ ModuleName }}'
      - name: VersionId
        value: '{{ VersionId }}'

Permissions

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

Create

cloudformation:DescribeType,
cloudformation:SetTypeDefaultVersion

Read

cloudformation:DescribeType

List

cloudformation:ListTypes