software.amazon.awscdk

Class LegacyStackSynthesizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.StackSynthesizer

software.amazon.awscdk.LegacyStackSynthesizer

All Implemented Interfaces:

IStackSynthesizer, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.920Z")
 @Stability(value=Stable)
public class LegacyStackSynthesizer
extends StackSynthesizer

Use the CDK classic way of referencing assets.

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

• It does not support cross-account deployment (the CLI must have credentials to the account you are trying to deploy to).
• It cannot be used with CDK Pipelines. To deploy using CDK Pipelines, you must use the DefaultStackSynthesizer.
• Each asset will take up a CloudFormation Parameter in your template. Keep in mind that there is a maximum of 200 parameters in a CloudFormation template. To use determinstic asset locations instead, use CliCredentialsStackSynthesizer.

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().

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 LegacyStackSynthesizer legacyStackSynthesizer = new LegacyStackSynthesizer();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IStackSynthesizer

IStackSynthesizer.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	LegacyStackSynthesizer()
protected	LegacyStackSynthesizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	LegacyStackSynthesizer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
DockerImageAssetLocation	addDockerImageAsset(DockerImageAssetSource asset) Register a Docker Image Asset.
FileAssetLocation	addFileAsset(FileAssetSource asset) Register a File Asset.
void	bind(Stack stack) Bind to the stack this environment is going to be used on.
void	synthesize(ISynthesisSession session) Synthesize the associated stack to the session.

Methods inherited from class software.amazon.awscdk.StackSynthesizer

emitStackArtifact, emitStackArtifact, synthesizeStackTemplate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

LegacyStackSynthesizer

protected LegacyStackSynthesizer(software.amazon.jsii.JsiiObjectRef objRef)

LegacyStackSynthesizer

protected LegacyStackSynthesizer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

LegacyStackSynthesizer

@Stability(value=Stable)
public LegacyStackSynthesizer()

Method Detail

addDockerImageAsset

@Stability(value=Stable)
 @NotNull
public DockerImageAssetLocation addDockerImageAsset(@NotNull
                                                                                       DockerImageAssetSource asset)

Register a Docker Image Asset.

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

Specified by:

addDockerImageAsset in interface IStackSynthesizer

Specified by:

addDockerImageAsset in class StackSynthesizer

Parameters:

asset - This parameter is required.

addFileAsset

@Stability(value=Stable)
 @NotNull
public FileAssetLocation addFileAsset(@NotNull
                                                                         FileAssetSource asset)

Register a File Asset.

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

Specified by:

addFileAsset in interface IStackSynthesizer

Specified by:

addFileAsset in class StackSynthesizer

Parameters:

asset - This parameter is required.

bind

@Stability(value=Stable)
public void bind(@NotNull
                                          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.

Specified by:

bind in interface IStackSynthesizer

Specified by:

bind in class StackSynthesizer

Parameters:

stack - This parameter is required.

synthesize

@Stability(value=Stable)
public void synthesize(@NotNull
                                                ISynthesisSession session)

Synthesize the associated stack to the session.

Specified by:

synthesize in interface IStackSynthesizer

Specified by:

synthesize in class StackSynthesizer

Parameters:

session - This parameter is required.