AWS::CloudFormation::ModuleVersion

CloudFormation ModuleVersion

A module that has been registered in the CloudFormation registry.

Properties

2 configurable properties. 2 required. Click a row to see details.

Filter:

Property	Type	Flags
`ModuleName`	`string`	RequiredCreate-only
`ModulePackage`	`string`	RequiredCreate-onlyWrite-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	The Amazon Resource Name (ARN) of the module.
`Description`	`string`	The description of the registered module.
`DocumentationUrl`	`string`	The URL of a page providing detailed documentation for this module.
`IsDefaultVersion`	`boolean`	Indicator of whether this module version is the current default version
`Schema`	`string`	The schema defining input parameters to and resources generated by the module.
`TimeCreated`	`string`	The time that the specified module version was registered.
`VersionId`	`string`	The version ID of the module represented by this module instance.
`Visibility`	`string`	The scope at which the type is visible and usable in CloudFormation operations. The only allowed value at present is: PRIVATE: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as PRIVATE.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CloudFormation::ModuleVersion

Resources:
  MyResource:
    Type: AWS::CloudFormation::ModuleVersion
    Properties:
      ModuleName: "my-modulename"
      ModulePackage: "value"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cloudformation:DescribeTypecloudformation:DescribeTypeRegistrationcloudformation:ListTypeVersionscloudformation:RegisterTypes3:GetObjects3:ListBucket

read

cloudformation:DescribeType

delete

cloudformation:DeregisterTypecloudformation:DescribeType

Get the CloudFormation Cheat Sheet

Everything you need to know about CloudFormation on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceCloudFormation

Properties10

Required2

TaggingNot supported

Primary IDArn

Supported Operations

CreateReadDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ModuleNameModulePackage

Related Resources

External Links

AWS Documentation