interface IReusableStackSynthesizer
Language | Type name |
---|---|
![]() | Amazon.CDK.IReusableStackSynthesizer |
![]() | github.com/aws/aws-cdk-go/awscdk/v2#IReusableStackSynthesizer |
![]() | software.amazon.awscdk.IReusableStackSynthesizer |
![]() | aws_cdk.IReusableStackSynthesizer |
![]() | aws-cdk-lib » IReusableStackSynthesizer |
Implemented by
App
, Bootstrapless
, Cli
, Default
, Legacy
Interface for Stack Synthesizers that can be used for more than one stack.
Regular IStackSynthesizer
instances can only be bound to a Stack once.
IReusableStackSynthesizer
instances.
For backwards compatibility reasons, this class inherits from
IStackSynthesizer
, but if an object implements IReusableStackSynthesizer
,
no other methods than reusableBind()
will be called.
Properties
Name | Type | Description |
---|---|---|
bootstrap | string | The qualifier used to bootstrap this stack. |
lookup | string | The role used to lookup for this stack. |
bootstrapQualifier?
Type:
string
(optional, default: no qualifier)
The qualifier used to bootstrap this stack.
lookupRole?
Type:
string
(optional, default: no role)
The role used to lookup for this stack.
Methods
Name | Description |
---|---|
add | Register a Docker Image Asset. |
add | Register a File Asset. |
bind(stack) | Bind to the stack this environment is going to be used on. |
reusable | Produce a bound Stack Synthesizer for the given stack. |
synthesize(session) | Synthesize the associated stack to the session. |
addDockerImageAsset(asset)
public addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocation
Parameters
- asset
Docker
Image Asset Source
Returns
Register a Docker Image Asset.
Returns the parameters that can be used to refer to the asset inside the template.
addFileAsset(asset)
public addFileAsset(asset: FileAssetSource): FileAssetLocation
Parameters
- asset
File
Asset Source
Returns
Register a File Asset.
Returns the parameters that can be used to refer to the asset inside the template.
bind(stack)
public bind(stack: Stack): void
Parameters
- 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.
reusableBind(stack)
public reusableBind(stack: Stack): IBoundStackSynthesizer
Parameters
- stack
Stack
Returns
Produce a bound Stack Synthesizer for the given stack.
This method may be called more than once on the same object.
synthesize(session)
public synthesize(session: ISynthesisSession): void
Parameters
- session
ISynthesis
Session
Synthesize the associated stack to the session.