class NestedStackSynthesizer

Language	Type name
.NET	Amazon.CDK.NestedStackSynthesizer
Java	software.amazon.awscdk.core.NestedStackSynthesizer
Python	aws_cdk.core.NestedStackSynthesizer
TypeScript (source)	@aws-cdk/core » NestedStackSynthesizer

Implements IStackSynthesizer

Extends StackSynthesizer

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.

Example

// 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/core';

declare const stackSynthesizer: cdk.StackSynthesizer;
const nestedStackSynthesizer = new cdk.NestedStackSynthesizer(stackSynthesizer);

Initializer

new NestedStackSynthesizer(parentDeployment: IStackSynthesizer)

Parameters

• parentDeployment IStackSynthesizer

Methods

Name	Description
addDockerImageAsset(asset)	Register a Docker Image Asset.
addFileAsset(asset)	Register a File Asset.
bind(stack)	Bind to the stack this environment is going to be used on.
synthesize(session)	Synthesize the associated stack to the session.

---

addDockerImageAsset(asset)

public addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocation

Parameters

• asset DockerImageAssetSource

Returns

• DockerImageAssetLocation

Register a Docker Image Asset.

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

---

addFileAsset(asset)

public addFileAsset(asset: FileAssetSource): FileAssetLocation

Parameters

• asset FileAssetSource

Returns

• FileAssetLocation

Register a File Asset.

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

---

bind(stack)

public bind(stack: Stack): void

Parameters

• 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)

public synthesize(session: ISynthesisSession): void

Parameters

• session ISynthesisSession

Synthesize the associated stack to the session.