software.amazon.awscdk

Class NestedStack

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Stack

software.amazon.awscdk.NestedStack

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:43.744Z")
 @Stability(value=Experimental)
public class NestedStack
extends Stack

(experimental) A CloudFormation nested stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but does not update the resources of unmodified nested stacks.

Furthermore, 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.

Cross references of resource attributes between the parent stack and the nested stack will automatically be translated to stack parameters and outputs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NestedStack.Builder (experimental) A fluent builder for NestedStack.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CfnResource	getNestedStackResource() (experimental) If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource.
String	getStackId() (experimental) An attribute that represents the ID of the stack.
String	getStackName() (experimental) An attribute that represents the name of the nested stack.
String	getTemplateFile() (experimental) The name of the CloudFormation template file emitted to the output directory during synthesis.
static Boolean	isNestedStack(Object x) (experimental) Checks if `x` is an object of type `NestedStack`.
void	setParameter(String name, String value) (experimental) Assign a value to one of the nested stack parameters.

Methods inherited from class software.amazon.awscdk.Stack

addDependency, addDependency, addTransform, allocateLogicalId, exportValue, exportValue, formatArn, getAccount, getArtifactId, getAvailabilityZones, getDependencies, getEnvironment, getLogicalId, getNested, getNestedStackParent, getNotificationArns, getPartition, getRegion, getSynthesizer, getTags, getTemplateOptions, getTerminationProtection, getUrlSuffix, isStack, of, parseArn, parseArn, parseArn, renameLogicalId, reportMissingContextKey, resolve, toJsonString, toJsonString

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 Detail

NestedStack

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

NestedStack

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

NestedStack

@Stability(value=Experimental)
public NestedStack(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @Nullable
                                                  NestedStackProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

NestedStack

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

isNestedStack

@Stability(value=Experimental)
 @NotNull
public static Boolean isNestedStack(@NotNull
                                                                             Object x)

(experimental) Checks if `x` is an object of type `NestedStack`.

Parameters:

x - This parameter is required.

setParameter

@Stability(value=Experimental)
public void setParameter(@NotNull
                                                        String name,
                                                        @NotNull
                                                        String value)

(experimental) Assign a value to one of the nested stack parameters.

Parameters:

name - The parameter name (ID). This parameter is required.

value - The value to assign. This parameter is required.

getStackId

@Stability(value=Experimental)
 @NotNull
public String getStackId()

(experimental) An attribute that represents the ID of the stack.

This is a context aware attribute:

• If this is referenced from the parent stack, it will return { "Ref": "LogicalIdOfNestedStackResource" }.
• If this is referenced from the context of the nested stack, it will return { "Ref": "AWS::StackId" }

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 "arn:aws:cloudformation:us-east-2:123456789012:stack/mystack-mynestedstack-sggfrhxhum7w/f449b250-b969-11e0-a185-5081d0136786";

Overrides:

getStackId in class Stack

getStackName

@Stability(value=Experimental)
 @NotNull
public String getStackName()

(experimental) An attribute that represents the name of the nested stack.

This is a context aware attribute:

• If this is referenced from the parent stack, it will return a token that parses the name from the stack ID.
• If this is referenced from the context of the nested stack, it will return { "Ref": "AWS::StackName" }

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 mystack - mynestedstack - sggfrhxhum7w;

Overrides:

getStackName in class Stack

getTemplateFile

@Stability(value=Experimental)
 @NotNull
public String getTemplateFile()

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

Overrides:

getTemplateFile in class Stack

getNestedStackResource

@Stability(value=Experimental)
 @Nullable
public CfnResource getNestedStackResource()

(experimental) If this is a nested stack, this represents its `AWS::CloudFormation::Stack` resource.

undefined for top-level (non-nested) stacks.

Overrides:

getNestedStackResource in class Stack