Interface ProductStackHistoryProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ProductStackHistoryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:39.801Z") @Stability(Stable) public interface ProductStackHistoryProps extends software.amazon.jsii.JsiiSerializable
Properties for a ProductStackHistory.

Example:

 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.core.*;
 public class S3BucketProduct extends ProductStack {
     public S3BucketProduct(Construct scope, String id) {
         super(scope, id);
         new Bucket(this, "BucketProductV2");
     }
 }
 ProductStackHistory productStackHistory = ProductStackHistory.Builder.create(this, "ProductStackHistory")
         .productStack(new S3BucketProduct(this, "S3BucketProduct"))
         .currentVersionName("v2")
         .currentVersionLocked(true)
         .build();
 CloudFormationProduct product = CloudFormationProduct.Builder.create(this, "MyFirstProduct")
         .productName("My Product")
         .owner("Product Owner")
         .productVersions(List.of(productStackHistory.currentVersion()))
         .build();
 
  • Method Details

    • getCurrentVersionLocked

      @Stability(Stable) @NotNull Boolean getCurrentVersionLocked()
      If this is set to true, the ProductStack will not be overwritten if a snapshot is found for the currentVersionName.
    • getCurrentVersionName

      @Stability(Stable) @NotNull String getCurrentVersionName()
      The current version name of the ProductStack.
    • getProductStack

      @Stability(Stable) @NotNull ProductStack getProductStack()
      The ProductStack whose history will be retained as a snapshot.
    • getDescription

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

      Default: - No description provided

    • getDirectory

      @Stability(Stable) @Nullable default String getDirectory()
      The directory where template snapshots will be stored.

      Default: 'product-stack-snapshots'

    • getValidateTemplate

      @Stability(Stable) @Nullable default Boolean getValidateTemplate()
      Whether the specified product template will be validated by CloudFormation.

      If turned off, an invalid template configuration can be stored.

      Default: true

    • builder

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