software.amazon.awscdk.services.servicecatalog

Class ProductStack

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Stack

software.amazon.awscdk.services.servicecatalog.ProductStack

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-08T16:00:26.957Z")
 @Stability(value=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:

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

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.awscdk.core.Stack

Stack.Builder

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

software.amazon.jsii.JsiiObject.InitializationMode

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class software.amazon.awscdk.core.Stack

addDependency, addDependency, addDockerImageAsset, addFileAsset, addTransform, allocateLogicalId, exportValue, exportValue, formatArn, getAccount, getArtifactId, getAvailabilityZones, getBundlingRequired, getDependencies, getEnvironment, getLogicalId, getNested, getNestedStackParent, getNestedStackResource, getNotificationArns, getParentStack, getPartition, getRegion, getStackId, getStackName, getSynthesizer, getTags, getTemplateOptions, getTerminationProtection, getUrlSuffix, isStack, of, parseArn, parseArn, parseArn, prepareCrossReference, regionalFact, regionalFact, renameLogicalId, reportMissingContext, reportMissingContextKey, resolve, splitArn, toJsonString, toJsonString

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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 Detail

ProductStack

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

ProductStack

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

ProductStack

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

getTemplateFile

@Stability(value=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