Skip to content

StackSynthesizer

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.

Initializers

import com.aliyun.ros.cdk.core.StackSynthesizer;
new StackSynthesizer();
Name Type Description

Methods

Name Description
addFileAsset Register a File Asset.
bind Bind to the stack this environment is going to be used on.
synthesize Synthesize the associated stack to the session.

addFileAsset

public FileAssetLocation addFileAsset(FileAssetSource asset)

Register a File Asset.

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

The synthesizer must rely on some out-of-band mechanism to make sure the given files are actually placed in the returned location before the deployment happens. This can be by writing the instructions to the asset manifest (for use by the cdk-assets tool), by relying on the CLI to upload files (legacy behavior), or some other operator controlled mechanism.

assetRequired


bind

public void bind(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.

stackRequired


synthesize

public void synthesize(ISynthesisSession session)

Synthesize the associated stack to the session.

sessionRequired