AWS CDK Reference

Appearance

v2.273.0

NestedStackSynthesizer Class ​

Synthesizer for a nested stack.

Forwards all calls to the parent stack's synthesizer.

This synthesizer is automatically used for NestedStack constructs. App builder do not need to use this class directly.

Source
core/lib/stack-synthesizers/nested.ts
Type last changed
v2.253.1 · 8 May 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';

declare const stackSynthesizer: cdk.StackSynthesizer;
const nestedStackSynthesizer = new cdk.NestedStackSynthesizer(stackSynthesizer);
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

# stack_synthesizer: cdk.StackSynthesizer

nested_stack_synthesizer = cdk.NestedStackSynthesizer(stack_synthesizer)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;

StackSynthesizer stackSynthesizer;

NestedStackSynthesizer nestedStackSynthesizer = new NestedStackSynthesizer(stackSynthesizer);
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;

StackSynthesizer stackSynthesizer;

var nestedStackSynthesizer = new NestedStackSynthesizer(stackSynthesizer);
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"

var stackSynthesizer StackSynthesizer

nestedStackSynthesizer := cdk.NewNestedStackSynthesizer(stackSynthesizer)

Initializer ​

ts
new NestedStackSynthesizer(parentDeployment: IStackSynthesizer)
python
NestedStackSynthesizer(parent_deployment: IStackSynthesizer)
java
new NestedStackSynthesizer(IStackSynthesizer parentDeployment)
csharp
new NestedStackSynthesizer(IStackSynthesizer parentDeployment)
go
NewNestedStackSynthesizer(ParentDeployment IStackSynthesizer)

Properties ​

bootstrapQualifierstringbootstrap_qualifierstrbootstrapQualifierStringBootstrapQualifierstringBootstrapQualifier*string#
The qualifier used to bootstrap this stack.
cloudFormationExecutionRolestringcloud_formation_execution_rolestrcloudFormationExecutionRoleStringCloudFormationExecutionRolestringCloudFormationExecutionRole*string#
The role that is passed to CloudFormation to execute the change set.
lookupRolestringlookup_rolestrlookupRoleStringLookupRolestringLookupRole*string#
The role used to lookup for this stack.

Methods ​

addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocationdef add_docker_image_asset(self, asset: DockerImageAssetSource) -> DockerImageAssetLocationpublic DockerImageAssetLocation addDockerImageAsset(DockerImageAssetSource asset)public DockerImageAssetLocation AddDockerImageAsset(DockerImageAssetSource asset)func AddDockerImageAsset(Asset DockerImageAssetSource) DockerImageAssetLocation#
Register a Docker Image Asset.
notes

Returns the parameters that can be used to refer to the asset inside the template.

The synthesizer must rely on some out-of-band mechanism to make sure the given files are actually placed in the returned location before the deployment happens. This can be by writing the instructions to the asset manifest (for use by the cdk-assets tool), by relying on the CLI to upload files (legacy behavior), or some other operator controlled mechanism.

addFileAsset(asset: FileAssetSource): FileAssetLocationdef add_file_asset(self, asset: FileAssetSource) -> FileAssetLocationpublic FileAssetLocation addFileAsset(FileAssetSource asset)public FileAssetLocation AddFileAsset(FileAssetSource asset)func AddFileAsset(Asset FileAssetSource) FileAssetLocation#
Register a File Asset.
notes

Returns the parameters that can be used to refer to the asset inside the template.

The synthesizer must rely on some out-of-band mechanism to make sure the given files are actually placed in the returned location before the deployment happens. This can be by writing the instructions to the asset manifest (for use by the cdk-assets tool), by relying on the CLI to upload files (legacy behavior), or some other operator controlled mechanism.

bind(stack: Stack): voiddef bind(self, stack: Stack) -> Nonepublic void bind(Stack stack)public void Bind(Stack stack)func Bind(Stack Stack)#
Bind to the stack this environment is going to be used on.

Must be called before any of the other methods are called.

synthesize(session: ISynthesisSession): voiddef synthesize(self, session: ISynthesisSession) -> Nonepublic void synthesize(ISynthesisSession session)public void Synthesize(ISynthesisSession session)func Synthesize(Session ISynthesisSession)#
Synthesize the associated stack to the session.