AWS CDK Reference

Appearance

v2.274.0

CfnPublicTypeVersionProps Struct ​

Properties for defining a CfnPublicTypeVersion.

Source
Generated code

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnPublicTypeVersionProps: cdk.CfnPublicTypeVersionProps = {
  arn: 'arn',
  logDeliveryBucket: 'logDeliveryBucket',
  publicVersionNumber: 'publicVersionNumber',
  type: 'type',
  typeName: 'typeName',
};

Properties ​

arnstringarnstrarnStringArnstringArn*string#
The Amazon Resource Number (ARN) of the extension.

Conditional: You must specify Arn , or TypeName and Type .

logDeliveryBucketstringlog_delivery_bucketstrlogDeliveryBucketStringLogDeliveryBucketstringLogDeliveryBucket*string#
The S3 bucket to which CloudFormation delivers the contract test execution logs.
notes

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
publicVersionNumberstringpublic_version_numberstrpublicVersionNumberStringPublicVersionNumberstringPublicVersionNumber*string#
The version number to assign to this version of the extension.
notes

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 .

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 .

typestringtypestrtypeStringTypestringType*string#
The type of the extension to test.

Conditional: You must specify Arn , or TypeName and Type .

typeNamestringtype_namestrtypeNameStringTypeNamestringTypeName*string#
The name of the extension to test.

Conditional: You must specify Arn , or TypeName and Type .