Table of Contents

Class StackSynthesizer

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

Base class for implementing an IStackSynthesizer.

public abstract class StackSynthesizer : DeputyBase, IStackSynthesizer
Inheritance
StackSynthesizer
Implements
Derived

Remarks

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.

Constructors

StackSynthesizer() 

protected StackSynthesizer()

Methods

AddDockerImageAsset(IDockerImageAssetSource)

Register a Docker Image Asset.

public abstract IDockerImageAssetLocation AddDockerImageAsset(IDockerImageAssetSource asset)

Parameters

asset IDockerImageAssetSource

Returns

IDockerImageAssetLocation

Remarks

Returns the parameters that can be used to refer to the asset inside the template.

AddFileAsset(IFileAssetSource)

Register a File Asset.

public abstract IFileAssetLocation AddFileAsset(IFileAssetSource asset)

Parameters

asset IFileAssetSource

Returns

IFileAssetLocation

Remarks

Returns the parameters that can be used to refer to the asset inside the template.

Bind(Stack)

Bind to the stack this environment is going to be used on.

public abstract void Bind(Stack stack)

Parameters

stack Stack

Remarks

Must be called before any of the other methods are called.

EmitStackArtifact(Stack, ISynthesisSession, ISynthesizeStackArtifactOptions?)

Write the stack artifact to the session.

protected virtual void EmitStackArtifact(Stack stack, ISynthesisSession session, ISynthesizeStackArtifactOptions? options = null)

Parameters

stack Stack
session ISynthesisSession
options ISynthesizeStackArtifactOptions

Remarks

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

Synthesize(ISynthesisSession)

Synthesize the associated stack to the session.

public abstract void Synthesize(ISynthesisSession session)

Parameters

session ISynthesisSession

SynthesizeStackTemplate(Stack, ISynthesisSession)

Have the stack write out its template.

protected virtual void SynthesizeStackTemplate(Stack stack, ISynthesisSession session)

Parameters

stack Stack
session ISynthesisSession