class StackSynthesizer

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

Implements IStackSynthesizer

Implemented by BootstraplessSynthesizer, CliCredentialsStackSynthesizer, DefaultStackSynthesizer, LegacyStackSynthesizer, NestedStackSynthesizer

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 @_internal to the framework and could not be accessed by external implementors.

Initializer

new StackSynthesizer()

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.
protected emitStackArtifact(stack, session, options?)	Write the stack artifact to the session.
protected synthesizeStackTemplate(stack, session)	Have the stack write out its template.

---

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.

---

protected emitStackArtifact(stack, session, options?)

protected emitStackArtifact(stack: Stack, session: ISynthesisSession, options?: SynthesizeStackArtifactOptions): void

Parameters

• stack Stack
• session ISynthesisSession
• options SynthesizeStackArtifactOptions

Write the stack artifact to the session.

Use default settings to add a CloudFormationStackArtifact artifact to the given synthesis session.

---

protected synthesizeStackTemplate(stack, session)

protected synthesizeStackTemplate(stack: Stack, session: ISynthesisSession): void

Parameters

• stack Stack
• session ISynthesisSession

Have the stack write out its template.