Package 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.104.0 (build e79254c)", date="2024-11-21T06:34:02.099Z") @Stability(Stable) public class CfnPublicTypeVersion extends CfnResource implements IInspectable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPublicTypeVersion

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

    • CfnPublicTypeVersion

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

    • CfnPublicTypeVersion

      @Stability(Stable) public CfnPublicTypeVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnPublicTypeVersionProps props)
      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.
      props - Resource properties.

    • CfnPublicTypeVersion

      @Stability(Stable) public CfnPublicTypeVersion(@NotNull software.constructs.Construct scope, @NotNull 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.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrPublicTypeArn()
      The Amazon Resource Number (ARN) assigned to the public extension upon publication.

    • getAttrPublisherId

      @Stability(Stable) @NotNull public String getAttrPublisherId()
      The publisher ID of the extension publisher.

      This applies only to public third-party extensions. For private registered extensions, and extensions provided by AWS , CloudFormation returns null .

    • getAttrTypeVersionArn

      @Stability(Stable) @NotNull public String getAttrTypeVersionArn()
      The Amazon Resource Number (ARN) assigned to this version of the extension.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getArn

      @Stability(Stable) @Nullable public String getArn()
      The Amazon Resource Number (ARN) of the extension.

    • setArn

      @Stability(Stable) public void setArn(@Nullable String value)
      The Amazon Resource Number (ARN) of the extension.

    • getLogDeliveryBucket

      @Stability(Stable) @Nullable public String getLogDeliveryBucket()
      The S3 bucket to which CloudFormation delivers the contract test execution logs.

    • setLogDeliveryBucket

      @Stability(Stable) public void setLogDeliveryBucket(@Nullable String value)
      The S3 bucket to which CloudFormation delivers the contract test execution logs.

    • getPublicVersionNumber

      @Stability(Stable) @Nullable public String getPublicVersionNumber()
      The version number to assign to this version of the extension.

    • setPublicVersionNumber

      @Stability(Stable) public void setPublicVersionNumber(@Nullable String value)
      The version number to assign to this version of the extension.

    • getType

      @Stability(Stable) @Nullable public String getType()
      The type of the extension to test.

    • setType

      @Stability(Stable) public void setType(@Nullable String value)
      The type of the extension to test.

    • getTypeName

      @Stability(Stable) @Nullable public String getTypeName()
      The name of the extension to test.

    • setTypeName

      @Stability(Stable) public void setTypeName(@Nullable String value)
      The name of the extension to test.