Package software.amazon.awscdk

Interface IStackSynthesizer

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IBoundStackSynthesizer, IBoundStackSynthesizer.Jsii$Default, IReusableStackSynthesizer, IReusableStackSynthesizer.Jsii$Default, IStackSynthesizer.Jsii$Default

All Known Implementing Classes:

AppStagingSynthesizer, BootstraplessSynthesizer, CliCredentialsStackSynthesizer, DefaultStackSynthesizer, IBoundStackSynthesizer.Jsii$Proxy, IReusableStackSynthesizer.Jsii$Proxy, IStackSynthesizer.Jsii$Proxy, LegacyStackSynthesizer, NestedStackSynthesizer, StackSynthesizer

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-05T03:43:37.547Z")
@Stability(Stable)
public interface IStackSynthesizer
extends software.amazon.jsii.JsiiSerializable

Encodes information how a certain Stack should be deployed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IStackSynthesizer.Jsii$Default	Internal default implementation for IStackSynthesizer.
static final class	IStackSynthesizer.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	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.
default String	getBootstrapQualifier()	The qualifier used to bootstrap this stack.
default String	getLookupRole()	The role used to lookup for this stack.
void	synthesize(ISynthesisSession session)	Synthesize the associated stack to the session.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBootstrapQualifier

@Stability(Stable)
@Nullable
default String getBootstrapQualifier()

The qualifier used to bootstrap this stack.

Default: - no qualifier

getLookupRole

@Stability(Stable)
@Nullable
default String getLookupRole()

The role used to lookup for this stack.

Default: - no role

addDockerImageAsset

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

Parameters:

asset - This parameter is required.

addFileAsset

@Stability(Stable)
@NotNull
FileAssetLocation addFileAsset(@NotNull
 FileAssetSource asset)

Register a File Asset.

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

Parameters:

asset - This parameter is required.

bind

@Stability(Stable)
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, and can only be called once.

Parameters:

stack - This parameter is required.

synthesize

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

Synthesize the associated stack to the session.

Parameters:

session - This parameter is required.