Table of Contents

Class LegacyStackSynthesizer

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

Use the CDK classic way of referencing assets.

public class LegacyStackSynthesizer : StackSynthesizer, IStackSynthesizer
Inheritance
LegacyStackSynthesizer
Implements
Inherited Members

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             var legacyStackSynthesizer = new LegacyStackSynthesizer();

Remarks

This synthesizer will generate CloudFormation parameters for every referenced asset, and use the CLI's current credentials to deploy the stack.

    Be aware that your CLI credentials must be valid for the duration of the entire deployment. If you are using session credentials, make sure the session lifetime is long enough.

    This is the only StackSynthesizer that supports customizing asset behavior by overriding Stack.addFileAsset() and Stack.addDockerImageAsset().

    ExampleMetadata: fixture=_generated

    Constructors

    LegacyStackSynthesizer() 

    public LegacyStackSynthesizer()

    Methods

    AddDockerImageAsset(IDockerImageAssetSource)

    Register a Docker Image Asset.

    public override 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 override 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 override void Bind(Stack stack)

    Parameters

    stack Stack

    Remarks

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

    Synthesize(ISynthesisSession)

    Synthesize the associated stack to the session.

    public override void Synthesize(ISynthesisSession session)

    Parameters

    session ISynthesisSession