interface IStackSynthesizer

Language	Type name
.NET	Amazon.CDK.IStackSynthesizer
Go	github.com/aws/aws-cdk-go/awscdk/v2#IStackSynthesizer
Java	software.amazon.awscdk.IStackSynthesizer
Python	aws_cdk.IStackSynthesizer
TypeScript (source)	aws-cdk-lib » IStackSynthesizer

Implemented by AppStagingSynthesizer, BootstraplessSynthesizer, CliCredentialsStackSynthesizer, DefaultStackSynthesizer, LegacyStackSynthesizer, NestedStackSynthesizer

Encodes information how a certain Stack should be deployed.

Properties

Name	Type	Description
bootstrapQualifier?	string	The qualifier used to bootstrap this stack.
lookupRole?	string	The role used to lookup for this stack.

---

bootstrapQualifier?

Type: string (optional, default: no qualifier)

The qualifier used to bootstrap this stack.

---

lookupRole?

Type: string (optional, default: no role)

The role used to lookup for this stack.

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, and can only be called once.

---

synthesize(session)

public synthesize(session: ISynthesisSession): void

Parameters

• session ISynthesisSession

Synthesize the associated stack to the session.