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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the module version to set as the default version.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	module_default_versions	INSERT	region
list_resources	module_default_versions_list_only	SELECT	region
get_resource	module_default_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual module_default_version.

SELECT
  region,
  arn,
  module_name,
  version_id
FROM awscc.cloudformation.module_default_versions
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all module_default_versions in a region.

SELECT
  region,
  arn
FROM awscc.cloudformation.module_default_versions_list_only
WHERE
  region = 'us-east-1';

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 awscc.cloudformation.module_default_versions (
  Arn,
  ModuleName,
  VersionId,
  region
)
SELECT
  '{{ arn }}',
  '{{ module_name }}',
  '{{ version_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cloudformation.module_default_versions (
  Arn,
  ModuleName,
  VersionId,
  region
)
SELECT
  '{{ arn }}',
  '{{ module_name }}',
  '{{ version_id }}',
  '{{ 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: module_name
        value: '{{ module_name }}'
      - name: version_id
        value: '{{ version_id }}'

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