software.amazon.awscdk.services.servicecatalog

Class ProductStackHistory.Builder

java.lang.Object

software.amazon.awscdk.services.servicecatalog.ProductStackHistory.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ProductStackHistory>

Enclosing class:

ProductStackHistory

@Stability(value=Stable)
public static final class ProductStackHistory.Builder
extends Object
implements software.amazon.jsii.Builder<ProductStackHistory>

A fluent builder for ProductStackHistory.

Method Summary

Modifier and Type	Method and Description
ProductStackHistory	build()
static ProductStackHistory.Builder	create(software.constructs.Construct scope, String id)
ProductStackHistory.Builder	currentVersionLocked(Boolean currentVersionLocked) If this is set to true, the ProductStack will not be overwritten if a snapshot is found for the currentVersionName.
ProductStackHistory.Builder	currentVersionName(String currentVersionName) The current version name of the ProductStack.
ProductStackHistory.Builder	description(String description) The description of the product version.
ProductStackHistory.Builder	directory(String directory) The directory where template snapshots will be stored.
ProductStackHistory.Builder	productStack(ProductStack productStack) The ProductStack whose history will be retained as a snapshot.
ProductStackHistory.Builder	validateTemplate(Boolean validateTemplate) Whether the specified product template will be validated by CloudFormation.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static ProductStackHistory.Builder create(software.constructs.Construct scope,
                                                                          String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ProductStackHistory.Builder.

currentVersionLocked

@Stability(value=Stable)
public ProductStackHistory.Builder currentVersionLocked(Boolean currentVersionLocked)

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

Parameters:

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

Returns:

this

currentVersionName

@Stability(value=Stable)
public ProductStackHistory.Builder currentVersionName(String currentVersionName)

The current version name of the ProductStack.

Parameters:

currentVersionName - The current version name of the ProductStack. This parameter is required.

Returns:

this

productStack

@Stability(value=Stable)
public ProductStackHistory.Builder productStack(ProductStack productStack)

The ProductStack whose history will be retained as a snapshot.

Parameters:

productStack - The ProductStack whose history will be retained as a snapshot. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public ProductStackHistory.Builder description(String description)

The description of the product version.

Default: - No description provided

Parameters:

description - The description of the product version. This parameter is required.

Returns:

this

directory

@Stability(value=Stable)
public ProductStackHistory.Builder directory(String directory)

The directory where template snapshots will be stored.

Default: 'product-stack-snapshots'

Parameters:

directory - The directory where template snapshots will be stored. This parameter is required.

Returns:

this

validateTemplate

@Stability(value=Stable)
public ProductStackHistory.Builder validateTemplate(Boolean validateTemplate)

Whether the specified product template will be validated by CloudFormation.

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

Default: true

Parameters:

validateTemplate - Whether the specified product template will be validated by CloudFormation. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public ProductStackHistory build()

Specified by:

build in interface software.amazon.jsii.Builder<ProductStackHistory>