Package software.amazon.awscdk.services.servicecatalog

Interface CloudFormationProductProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CloudFormationProductProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:51.411Z") @Stability(Stable) public interface CloudFormationProductProps extends software.amazon.jsii.JsiiSerializable
Properties for a Cloudformation Product.

Example: 

 import software.amazon.awscdk.*;
 public class S3BucketProduct extends ProductStack {
     public S3BucketProduct(Construct scope, String id) {
         super(scope, id);
         new Bucket(this, "BucketProduct");
     }
 }
 CloudFormationProduct product = CloudFormationProduct.Builder.create(this, "Product")
         .productName("My Product")
         .owner("Product Owner")
         .productVersions(List.of(CloudFormationProductVersion.builder()
                 .productVersionName("v1")
                 .cloudFormationTemplate(CloudFormationTemplate.fromProductStack(new S3BucketProduct(this, "S3BucketProduct")))
                 .build()))
         .build();

  • Method Details

    • getOwner

      @Stability(Stable) @NotNull String getOwner()
      The owner of the product.

    • getProductName

      @Stability(Stable) @NotNull String getProductName()
      The name of the product.

    • getProductVersions

      @Stability(Stable) @NotNull List<CloudFormationProductVersion> getProductVersions()
      The configuration of the product version.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the product.

      Default: - No description provided

    • getDistributor

      @Stability(Stable) @Nullable default String getDistributor()
      The distributor of the product.

      Default: - No distributor provided

    • getMessageLanguage

      @Stability(Stable) @Nullable default MessageLanguage getMessageLanguage()
      The language code.

      Controls language for logging and errors.

      Default: - English

    • getReplaceProductVersionIds

      @Stability(Stable) @Nullable default Boolean getReplaceProductVersionIds()
      Whether to give provisioning artifacts a new unique identifier when the product attributes or provisioning artifacts is updated.

      Default: false

    • getSupportDescription

      @Stability(Stable) @Nullable default String getSupportDescription()
      The support information about the product.

      Default: - No support description provided

    • getSupportEmail

      @Stability(Stable) @Nullable default String getSupportEmail()
      The contact email for product support.

      Default: - No support email provided

    • getSupportUrl

      @Stability(Stable) @Nullable default String getSupportUrl()
      The contact URL for product support.

      Default: - No support URL provided

    • getTagOptions

      @Stability(Stable) @Nullable default TagOptions getTagOptions()
      TagOptions associated directly to a product.

      Default: - No tagOptions provided

    • builder

      @Stability(Stable) static CloudFormationProductProps.Builder builder()
      Returns:
      a CloudFormationProductProps.Builder of CloudFormationProductProps