AWS::CloudFormation::ResourceVersion

CloudFormation ResourceVersion

A resource that has been registered in the CloudFormation Registry.

Properties

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

Filter:

Property	Type	Flags
`SchemaHandlerPackage`	`string`	RequiredCreate-onlyWrite-only
`TypeName`	`string`	RequiredCreate-only
`ExecutionRoleArn`	`string`	Create-only
`LoggingConfig`	`LoggingConfig`	Create-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 type, here the ResourceVersion. This is used to uniquely identify a ResourceVersion resource
`IsDefaultVersion`	`boolean`	Indicates if this type version is the current default version
`ProvisioningType`	`string`	The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
`TypeArn`	`string`	The Amazon Resource Name (ARN) of the type without the versionID.
`VersionId`	`string`	The ID of the version of the type represented by this resource instance.
`Visibility`	`string`	The scope at which the type is visible and usable in CloudFormation operations. Valid values include: 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. PUBLIC: The type is publically visible and usable within any Amazon account.

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::ResourceVersion

Resources:
  MyResource:
    Type: AWS::CloudFormation::ResourceVersion
    Properties:
      SchemaHandlerPackage: "value"
      TypeName: "my-typename"

Required IAM Permissions

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

create

cloudformation:DescribeTypeRegistrationcloudformation:RegisterTypeiam:PassRoles3:GetObjects3:ListBucketkms:Decryptcloudformation:ListTypeVersionscloudformation:DeregisterTypecloudformation:DescribeType

read

cloudformation:DescribeType

delete

cloudformation:DeregisterTypecloudformation:DescribeType

list

cloudformation:ListTypes

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

CreateReadDeleteList

Immutable After Creation

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

ExecutionRoleArnLoggingConfigSchemaHandlerPackageTypeName

Related Resources

External Links

AWS Documentation