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.

import * as cdk from 'aws-cdk-lib';

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

new NestedStackSynthesizer(parentDeployment: IStackSynthesizer)

Parameters

• parentDeployment IStackSynthesizer

Type: string (optional)

The qualifier used to bootstrap this stack.

Type: string (optional)

The role used to lookup for this stack.

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.

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.

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.

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.

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.

public synthesize(session: ISynthesisSession): void

Parameters

• session ISynthesisSession

Synthesize the associated stack to the session.