AWS CDK Reference

Appearance

v2.274.0

StackSynthesizer Class ​

Base class for implementing an IStackSynthesizer.

This class needs to exist to provide public surface area for external implementations of stack synthesizers. The protected methods give access to functions that are otherwise

Source
core/lib/stack-synthesizers/stack-synthesizer.ts
Type last changed
v2.253.0 · 6 May 2026

Initializer ​

ts
new StackSynthesizer()
python
StackSynthesizer()
java
new StackSynthesizer()
csharp
new StackSynthesizer()
go
NewStackSynthesizer()

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.