Package software.amazon.awscdk.core

Class StackSynthesizer

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.StackSynthesizer

All Implemented Interfaces:

IStackSynthesizer, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

CliCredentialsStackSynthesizer, DefaultStackSynthesizer, LegacyStackSynthesizer, NestedStackSynthesizer

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:55.139Z")
@Stability(Stable)
public abstract class StackSynthesizer
extends software.amazon.jsii.JsiiObject
implements IStackSynthesizer

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.

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.core.IStackSynthesizer

IStackSynthesizer.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
abstract DockerImageAssetLocation	addDockerImageAsset(DockerImageAssetSource asset)	Register a Docker Image Asset.
abstract FileAssetLocation	addFileAsset(FileAssetSource asset)	Register a File Asset.
abstract void	bind(Stack stack)	Bind to the stack this environment is going to be used on.
protected void	emitStackArtifact(Stack stack, ISynthesisSession session)	Write the stack artifact to the session.
protected void	emitStackArtifact(Stack stack, ISynthesisSession session, SynthesizeStackArtifactOptions options)	Write the stack artifact to the session.
abstract void	synthesize(ISynthesisSession session)	Synthesize the associated stack to the session.
protected void	synthesizeStackTemplate(Stack stack, ISynthesisSession session)	Have the stack write out its template.

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 Details

StackSynthesizer

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

StackSynthesizer

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

StackSynthesizer

@Stability(Stable)
protected StackSynthesizer()

Method Details

addDockerImageAsset

@Stability(Stable)
@NotNull
public abstract 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

Parameters:

asset - This parameter is required.

addFileAsset

@Stability(Stable)
@NotNull
public abstract 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

Parameters:

asset - This parameter is required.

bind

@Stability(Stable)
public abstract 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

Parameters:

stack - This parameter is required.

emitStackArtifact

@Stability(Stable)
protected void emitStackArtifact(@NotNull
 Stack stack,
 @NotNull
 ISynthesisSession session,
 @Nullable
 SynthesizeStackArtifactOptions options)

Write the stack artifact to the session.

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

Parameters:

stack - This parameter is required.

session - This parameter is required.

options -

emitStackArtifact

@Stability(Stable)
protected void emitStackArtifact(@NotNull
 Stack stack,
 @NotNull
 ISynthesisSession session)

Write the stack artifact to the session.

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

Parameters:

stack - This parameter is required.

session - This parameter is required.

synthesize

@Stability(Stable)
public abstract void synthesize(@NotNull
 ISynthesisSession session)

Synthesize the associated stack to the session.

Specified by:

synthesize in interface IStackSynthesizer

Parameters:

session - This parameter is required.

synthesizeStackTemplate

@Stability(Stable)
protected void synthesizeStackTemplate(@NotNull
 Stack stack,
 @NotNull
 ISynthesisSession session)

Have the stack write out its template.

Parameters:

stack - This parameter is required.

session - This parameter is required.