Package software.amazon.awscdk.services.cloudformation

Interface CfnPublicTypeVersionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPublicTypeVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-19T18:11:56.868Z")
@Stability(Stable)
public interface CfnPublicTypeVersionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPublicTypeVersion.

Example:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPublicTypeVersionProps.Builder	A builder for CfnPublicTypeVersionProps
static final class	CfnPublicTypeVersionProps.Jsii$Proxy	An implementation for CfnPublicTypeVersionProps

Method Summary

Modifier and Type	Method	Description
static CfnPublicTypeVersionProps.Builder	builder()
default String	getArn()	The Amazon Resource Number (ARN) of the extension.
default String	getLogDeliveryBucket()	The S3 bucket to which CloudFormation delivers the contract test execution logs.
default String	getPublicVersionNumber()	The version number to assign to this version of the extension.
default String	getType()	The type of the extension to test.
default String	getTypeName()	The name of the extension to test.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArn

@Stability(Stable)
@Nullable
default String getArn()

The Amazon Resource Number (ARN) of the extension.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-arn

getLogDeliveryBucket

@Stability(Stable)
@Nullable
default String getLogDeliveryBucket()

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:

• GetObject
• PutObject

For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the AWS Identity and Access Management User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-logdeliverybucket

getPublicVersionNumber

@Stability(Stable)
@Nullable
default String getPublicVersionNumber()

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 .

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-publicversionnumber

getType

@Stability(Stable)
@Nullable
default String getType()

The type of the extension to test.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-type

getTypeName

@Stability(Stable)
@Nullable
default String getTypeName()

The name of the extension to test.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-publictypeversion.html#cfn-cloudformation-publictypeversion-typename

builder

@Stability(Stable)
static CfnPublicTypeVersionProps.Builder builder()

Returns:

a CfnPublicTypeVersionProps.Builder of CfnPublicTypeVersionProps