software.amazon.awscdk

Class CfnPublicTypeVersion

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.CfnPublicTypeVersion

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.836Z")
 @Stability(value=Stable)
public class CfnPublicTypeVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CloudFormation::PublicTypeVersion`.

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 in the CloudFormation 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 in the CloudFormation CLI User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnPublicTypeVersion cfnPublicTypeVersion = CfnPublicTypeVersion.Builder.create(this, "MyCfnPublicTypeVersion")
         .arn("arn")
         .logDeliveryBucket("logDeliveryBucket")
         .publicVersionNumber("publicVersionNumber")
         .type("type")
         .typeName("typeName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPublicTypeVersion.Builder A fluent builder for CfnPublicTypeVersion.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPublicTypeVersion(software.constructs.Construct scope, String id) Create a new `AWS::CloudFormation::PublicTypeVersion`.
	CfnPublicTypeVersion(software.constructs.Construct scope, String id, CfnPublicTypeVersionProps props) Create a new `AWS::CloudFormation::PublicTypeVersion`.
protected	CfnPublicTypeVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPublicTypeVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getArn() The Amazon Resource Number (ARN) of the extension.
String	getAttrPublicTypeArn() The Amazon Resource Number (ARN) assigned to the public extension upon publication.
String	getAttrPublisherId() The publisher ID of the extension publisher.
String	getAttrTypeVersionArn() The Amazon Resource Number (ARN) assigned to this version of the extension.
protected Map<String,Object>	getCfnProperties()
String	getLogDeliveryBucket() The S3 bucket to which CloudFormation delivers the contract test execution logs.
String	getPublicVersionNumber() The version number to assign to this version of the extension.
String	getType() The type of the extension to test.
String	getTypeName() The name of the extension to test.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setArn(String value) The Amazon Resource Number (ARN) of the extension.
void	setLogDeliveryBucket(String value) The S3 bucket to which CloudFormation delivers the contract test execution logs.
void	setPublicVersionNumber(String value) The version number to assign to this version of the extension.
void	setType(String value) The type of the extension to test.
void	setTypeName(String value) The name of the extension to test.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPublicTypeVersion

protected CfnPublicTypeVersion(software.amazon.jsii.JsiiObjectRef objRef)

CfnPublicTypeVersion

protected CfnPublicTypeVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPublicTypeVersion

@Stability(value=Stable)
public CfnPublicTypeVersion(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id,
                                                     @Nullable
                                                     CfnPublicTypeVersionProps props)

Create a new `AWS::CloudFormation::PublicTypeVersion`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnPublicTypeVersion

@Stability(value=Stable)
public CfnPublicTypeVersion(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id)

Create a new `AWS::CloudFormation::PublicTypeVersion`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrPublicTypeArn

@Stability(value=Stable)
 @NotNull
public String getAttrPublicTypeArn()

The Amazon Resource Number (ARN) assigned to the public extension upon publication.

getAttrPublisherId

@Stability(value=Stable)
 @NotNull
public String getAttrPublisherId()

The publisher ID of the extension publisher.

getAttrTypeVersionArn

@Stability(value=Stable)
 @NotNull
public String getAttrTypeVersionArn()

The Amazon Resource Number (ARN) assigned to this version of the extension.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getArn

@Stability(value=Stable)
 @Nullable
public String getArn()

The Amazon Resource Number (ARN) of the extension.

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

setArn

@Stability(value=Stable)
public void setArn(@Nullable
                                            String value)

The Amazon Resource Number (ARN) of the extension.

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

getLogDeliveryBucket

@Stability(value=Stable)
 @Nullable
public 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 .

setLogDeliveryBucket

@Stability(value=Stable)
public void setLogDeliveryBucket(@Nullable
                                                          String value)

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 .

getPublicVersionNumber

@Stability(value=Stable)
 @Nullable
public 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. AWS CloudFormation automatically sets the first version number to be 1.0.0 .

setPublicVersionNumber

@Stability(value=Stable)
public void setPublicVersionNumber(@Nullable
                                                            String value)

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 .

getType

@Stability(value=Stable)
 @Nullable
public String getType()

The type of the extension to test.

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

setType

@Stability(value=Stable)
public void setType(@Nullable
                                             String value)

The type of the extension to test.

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

getTypeName

@Stability(value=Stable)
 @Nullable
public String getTypeName()

The name of the extension to test.

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

setTypeName

@Stability(value=Stable)
public void setTypeName(@Nullable
                                                 String value)

The name of the extension to test.

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