Skip to content

DefaultStackSynthesizer

Uses conventionally named roles and reify asset storage locations.

Initializers

import { DefaultStackSynthesizer } from '@alicloud/ros-cdk-core'
new DefaultStackSynthesizer(props?: DefaultStackSynthesizerProps)
Name Type Description
props DefaultStackSynthesizerProps No description.

propsOptional


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.
reusableBind Produce a bound Stack Synthesizer for the given stack.
synthesizeStackArtifacts No description.

addFileAsset

public addFileAsset(asset: FileAssetSource): FileAssetLocation

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 bind(stack: Stack): void

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 synthesize(session: ISynthesisSession): void

Synthesize the associated stack to the session.

sessionRequired


reusableBind

public reusableBind(stack: Stack): IBoundStackSynthesizer

Produce a bound Stack Synthesizer for the given stack.

This method may be called more than once on the same object.

stackRequired


synthesizeStackArtifacts

public synthesizeStackArtifacts(session: ISynthesisSession): void

sessionRequired


Constants

Name Type Description
DEFAULT_FILE_ASSET_PREFIX string Default file asset prefix.
DEFAULT_FILE_ASSETS_BUCKET_NAME string Default file assets bucket name.
DEFAULT_QUALIFIER string Default ARN qualifier.

DEFAULT_FILE_ASSET_PREFIXRequired

public readonly DEFAULT_FILE_ASSET_PREFIX: string;
  • Type: string

Default file asset prefix.


DEFAULT_FILE_ASSETS_BUCKET_NAMERequired

public readonly DEFAULT_FILE_ASSETS_BUCKET_NAME: string;
  • Type: string

Default file assets bucket name.


DEFAULT_QUALIFIERRequired

public readonly DEFAULT_QUALIFIER: string;
  • Type: string

Default ARN qualifier.