aws-cdk-lib.IReusableStackSynthesizer

IReusableStackSynthesizer Interface

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.

IReusableStackSynthesizer

extends

• IStackSynthesizer

implemented by

• AppStagingSynthesizer,
• BootstraplessSynthesizer,
• 3 more

  • CliCredentialsStackSynthesizer,
  • DefaultStackSynthesizer,
  • LegacyStackSynthesizer

Source

core/lib/stack-synthesizers/types.ts

Type last changed

v2.61.0 · 19 Jan 2023

Properties

bootstrapQualifier?may be undefinedstringbootstrap_qualifier?may be undefinedstrbootstrapQualifier?may be undefinedStringBootstrapQualifier?may be undefinedstringBootstrapQualifier?may be undefined*string#

The qualifier used to bootstrap this stack.

Default: no qualifier

cloudFormationExecutionRole?may be undefinedstringcloud_formation_execution_role?may be undefinedstrcloudFormationExecutionRole?may be undefinedStringCloudFormationExecutionRole?may be undefinedstringCloudFormationExecutionRole?may be undefined*string#

The role that is passed to CloudFormation to execute the change set.

Default: no role

lookupRole?may be undefinedstringlookup_role?may be undefinedstrlookupRole?may be undefinedStringLookupRole?may be undefinedstringLookupRole?may be undefined*string#

The role used to lookup for this stack.

Default: no role

Methods

addDockerImageAsset(asset: DockerImageAssetSource): DockerImageAssetLocationdef add_docker_image_asset(self, asset: DockerImageAssetSource) -> DockerImageAssetLocationpublic DockerImageAssetLocation addDockerImageAsset(DockerImageAssetSource asset)public DockerImageAssetLocation AddDockerImageAsset(DockerImageAssetSource asset)func AddDockerImageAsset(Asset DockerImageAssetSource) DockerImageAssetLocation#

Register a Docker Image Asset.

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

addFileAsset(asset: FileAssetSource): FileAssetLocationdef add_file_asset(self, asset: FileAssetSource) -> FileAssetLocationpublic FileAssetLocation addFileAsset(FileAssetSource asset)public FileAssetLocation AddFileAsset(FileAssetSource asset)func AddFileAsset(Asset FileAssetSource) FileAssetLocation#

Register a File Asset.

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

bind(stack: Stack): voiddef bind(self, stack: Stack) -> Nonepublic void bind(Stack stack)public void Bind(Stack stack)func Bind(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: Stack): IBoundStackSynthesizerdef reusable_bind(self, stack: Stack) -> IBoundStackSynthesizerpublic IBoundStackSynthesizer reusableBind(Stack stack)public IBoundStackSynthesizer ReusableBind(Stack stack)func 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.

synthesize(session: ISynthesisSession): voiddef synthesize(self, session: ISynthesisSession) -> Nonepublic void synthesize(ISynthesisSession session)public void Synthesize(ISynthesisSession session)func Synthesize(Session ISynthesisSession)#

Synthesize the associated stack to the session.