Package software.amazon.awscdk.services.cloudformation

Class CfnPublicTypeVersion.Builder

java.lang.Object

software.amazon.awscdk.services.cloudformation.CfnPublicTypeVersion.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPublicTypeVersion>

Enclosing class:

CfnPublicTypeVersion

@Stability(Stable)
public static final class CfnPublicTypeVersion.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPublicTypeVersion>

A fluent builder for CfnPublicTypeVersion.

Method Summary

Modifier and Type	Method	Description
CfnPublicTypeVersion.Builder	arn(String arn)	The Amazon Resource Number (ARN) of the extension.
CfnPublicTypeVersion	build()
static CfnPublicTypeVersion.Builder	create(software.constructs.Construct scope, String id)
CfnPublicTypeVersion.Builder	logDeliveryBucket(String logDeliveryBucket)	The S3 bucket to which CloudFormation delivers the contract test execution logs.
CfnPublicTypeVersion.Builder	publicVersionNumber(String publicVersionNumber)	The version number to assign to this version of the extension.
CfnPublicTypeVersion.Builder	type(String type)	The type of the extension to test.
CfnPublicTypeVersion.Builder	typeName(String typeName)	The name of the extension to test.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnPublicTypeVersion.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnPublicTypeVersion.Builder.

arn

@Stability(Stable)
public CfnPublicTypeVersion.Builder arn(String arn)

The Amazon Resource Number (ARN) of the extension.

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

Parameters:

arn - The Amazon Resource Number (ARN) of the extension. This parameter is required.

Returns:

this

See Also:

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

logDeliveryBucket

@Stability(Stable)
public CfnPublicTypeVersion.Builder logDeliveryBucket(String logDeliveryBucket)

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 .

Parameters:

logDeliveryBucket - The S3 bucket to which CloudFormation delivers the contract test execution logs. This parameter is required.

Returns:

this

See Also:

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

publicVersionNumber

@Stability(Stable)
public CfnPublicTypeVersion.Builder publicVersionNumber(String publicVersionNumber)

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. AWS CloudFormation automatically sets the first version number to be 1.0.0 .

Parameters:

publicVersionNumber - The version number to assign to this version of the extension. This parameter is required.

Returns:

this

See Also:

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

type

@Stability(Stable)
public CfnPublicTypeVersion.Builder type(String type)

The type of the extension to test.

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

Parameters:

type - The type of the extension to test. This parameter is required.

Returns:

this

See Also:

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

typeName

@Stability(Stable)
public CfnPublicTypeVersion.Builder typeName(String typeName)

The name of the extension to test.

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

Parameters:

typeName - The name of the extension to test. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPublicTypeVersion build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPublicTypeVersion>

Returns:

a newly built instance of CfnPublicTypeVersion.