software.amazon.awscdk.services.servicecatalog

Interface ProductStackHistoryProps

All Known Implementing Classes:

ProductStackHistoryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:03.937Z")
public interface ProductStackHistoryProps

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ProductStackHistoryProps.Builder A builder for ProductStackHistoryProps
static class	ProductStackHistoryProps.Jsii$Proxy An implementation for ProductStackHistoryProps

Method Summary

Modifier and Type	Method and Description
static ProductStackHistoryProps.Builder	builder()
java.lang.Boolean	getCurrentVersionLocked() If this is set to true, the ProductStack will not be overwritten if a snapshot is found for the currentVersionName.
java.lang.String	getCurrentVersionName() The current version name of the ProductStack.
default java.lang.String	getDescription() The description of the product version.
default java.lang.String	getDirectory() The directory where template snapshots will be stored.
ProductStack	getProductStack() The ProductStack whose history will be retained as a snapshot.
default java.lang.Boolean	getValidateTemplate() Whether the specified product template will be validated by CloudFormation.

Method Detail

getCurrentVersionLocked

java.lang.Boolean getCurrentVersionLocked()

If this is set to true, the ProductStack will not be overwritten if a snapshot is found for the currentVersionName.

getCurrentVersionName

java.lang.String getCurrentVersionName()

The current version name of the ProductStack.

getProductStack

ProductStack getProductStack()

The ProductStack whose history will be retained as a snapshot.

getDescription

default java.lang.String getDescription()

The description of the product version.

Default: - No description provided

getDirectory

default java.lang.String getDirectory()

The directory where template snapshots will be stored.

Default: 'product-stack-snapshots'

getValidateTemplate

default java.lang.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

static ProductStackHistoryProps.Builder builder()

Returns:

a ProductStackHistoryProps.Builder of ProductStackHistoryProps