Package software.amazon.awscdk.services.servicecatalog

Class ProductStack

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Stack

software.amazon.awscdk.services.servicecatalog.ProductStack

All Implemented Interfaces:

ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:16.194Z")
@Stability(Stable)
public class ProductStack
extends Stack

A Service Catalog product stack, which is similar in form to a Cloudformation nested stack.

You can add the resources to this stack that you want to define for your service catalog product.

This stack will not be treated as an independent deployment artifact (won't be listed in "cdk list" or deployable through "cdk deploy"), but rather only synthesized as a template and uploaded as an asset to S3.

Example:

 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(), productStackHistory.versionFromSnapshot("v1")))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProductStack.Builder	A fluent builder for ProductStack.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProductStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ProductStack(software.amazon.jsii.JsiiObjectRef objRef)
	ProductStack(software.constructs.Construct scope, String id)
	ProductStack(software.constructs.Construct scope, String id, ProductStackProps props)

Method Summary

Modifier and Type	Method	Description
String	getTemplateFile()	The name of the CloudFormation template file emitted to the output directory during synthesis.

Methods inherited from class software.amazon.awscdk.Stack

addDependency, addDependency, addMetadata, addTransform, allocateLogicalId, exportStringListValue, exportStringListValue, exportValue, exportValue, formatArn, getAccount, getArtifactId, getAvailabilityZones, getBundlingRequired, getDependencies, getEnvironment, getLogicalId, getNested, getNestedStackParent, getNestedStackResource, getNotificationArns, getPartition, getRegion, getStackId, getStackName, getSynthesizer, getTags, getTemplateOptions, getTerminationProtection, getUrlSuffix, isStack, of, regionalFact, regionalFact, renameLogicalId, reportMissingContextKey, resolve, setTerminationProtection, splitArn, toJsonString, toJsonString, toYamlString

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ProductStack

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

ProductStack

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

ProductStack

@Stability(Stable)
public ProductStack(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ProductStackProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ProductStack

@Stability(Stable)
public ProductStack(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

getTemplateFile

@Stability(Stable)
@NotNull
public String getTemplateFile()

The name of the CloudFormation template file emitted to the output directory during synthesis.

Example value: MyStack.template.json

Overrides:

getTemplateFile in class Stack