Skip to content
v2.277.0

CfnPublicTypeVersionProps Struct ​

Properties for defining a CfnPublicTypeVersion.

Example ​

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

cfn_public_type_version_props = cloudformation.CfnPublicTypeVersionProps(
    arn="arn",
    log_delivery_bucket="logDeliveryBucket",
    public_version_number="publicVersionNumber",
    type="type",
    type_name="typeName"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.cloudformation.*;

CfnPublicTypeVersionProps cfnPublicTypeVersionProps = CfnPublicTypeVersionProps.builder()
        .arn("arn")
        .logDeliveryBucket("logDeliveryBucket")
        .publicVersionNumber("publicVersionNumber")
        .type("type")
        .typeName("typeName")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFormation;

var cfnPublicTypeVersionProps = new CfnPublicTypeVersionProps {
    Arn = "arn",
    LogDeliveryBucket = "logDeliveryBucket",
    PublicVersionNumber = "publicVersionNumber",
    Type = "type",
    TypeName = "typeName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnPublicTypeVersionProps := &CfnPublicTypeVersionProps{
	Arn: jsii.String("arn"),
	LogDeliveryBucket: jsii.String("logDeliveryBucket"),
	PublicVersionNumber: jsii.String("publicVersionNumber"),
	Type: jsii.String("type"),
	TypeName: jsii.String("typeName"),
}

Properties ​

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

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

logDeliveryBucketoptionalstringlog_delivery_bucketoptionalstrlogDeliveryBucketoptionalStringLogDeliveryBucketoptionalstringLogDeliveryBucketoptional*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
publicVersionNumberoptionalstringpublic_version_numberoptionalstrpublicVersionNumberoptionalStringPublicVersionNumberoptionalstringPublicVersionNumberoptional*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 .

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

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

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

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