Interface IStackSynthesizer

Interface that all stack synthesizers must implement.

A synthesizer is responsible for:

Collecting all ProviderResource descendants from a stack
Calling resource.toJson() on each to obtain resolved plain objects
Serializing those objects to a file in the output directory
Registering the output file as an artifact in the CloudAssemblyBuilder

interface IStackSynthesizer {
    bind(stack: IStackRef): void;
    collectDependencies?(): string[];
    synthesize(session: ISynthesisSession): void;
}

Implemented by

BaseStackSynthesizer

Index

Methods

bind collectDependencies? synthesize

Methods

bind

bind(stack: IStackRef): void
Called once when the synthesizer is associated with a stack. Use this to store a reference to the stack for use during synthesize().
Parameters
- stack: IStackRef
Returns void
- Defined in packages/core/src/lib/synthesizer/synthesizer.ts:34

`Optional`collectDependencies

collectDependencies?(): string[]
Optional. Returns the artifact IDs of stacks this stack depends on. Called by App.synth() before writing any files so that cross-stack cycles can be detected and reported without producing partial output.

Returns string[]
- Defined in packages/core/src/lib/synthesizer/synthesizer.ts:46

synthesize

synthesize(session: ISynthesisSession): void
Called during app.synth() to produce the stack's output artifact.
Parameters
- session: ISynthesisSession
Returns void
- Defined in packages/core/src/lib/synthesizer/synthesizer.ts:39