AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::CloudFormation::PublicTypeVersion

CfnPublicTypeVersion

The `AWS::CloudFormation::PublicTypeVersion` resource tests and publishes a registered extension as a public, third-party extension. CloudFormation first tests the extension to make sure it meets all necessary requirements for being published in the CloudFormation registry. If it does, CloudFormation then publishes it to the registry as a public third-party extension in this Region. Public extensions are available for use by all CloudFormation users. - For resource types, testing includes passing all contracts tests defined for the type. - For modules, testing includes determining if the module's model meets all necessary requirements. For more information, see [Testing your public extension prior to publishing](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing) in the *CloudFormation Command Line Interface (CLI) User Guide* . If you don't specify a version, CloudFormation uses the default version of the extension in your account and Region for testing. To perform testing, CloudFormation assumes the execution role specified when the type was registered. An extension must have a test status of `PASSED` before it can be published. For more information, see [Publishing extensions to make them available for public use](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html) in the *CloudFormation Command Line Interface (CLI) User Guide* .

Import

import { CfnPublicTypeVersion } from 'aws-cdk-lib/aws-cloudformation';

Or use the module namespace:

import * as cloudformation from 'aws-cdk-lib/aws-cloudformation';
// cloudformation.CfnPublicTypeVersion

Properties

Configuration passed to the constructor as CfnPublicTypeVersionProps.

arnOptional
string

The Amazon Resource Number (ARN) of the extension. Conditional: You must specify `Arn` , or `TypeName` and `Type` .

logDeliveryBucketOptional
string

The S3 bucket to which CloudFormation delivers the contract test execution logs. CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of `PASSED` or `FAILED` . The user initiating the stack operation must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions: - s3:GetObject - s3:PutObject

publicVersionNumberOptional
string

The version number to assign to this version of the extension. Use the following format, and adhere to semantic versioning when assigning a version number to your extension: `MAJOR.MINOR.PATCH` For more information, see [Semantic Versioning 2.0.0](https://docs.aws.amazon.com/https://semver.org/) . If you don't specify a version number, CloudFormation increments the version number by one minor version release. You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be `1.0.0` .

typeOptional
string

The type of the extension to test. Conditional: You must specify `Arn` , or `TypeName` and `Type` .

typeNameOptional
string

The name of the extension to test. Conditional: You must specify `Arn` , or `TypeName` and `Type` .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter