Class StackSynthesizer
Base class for implementing an IStackSynthesizer.
Inheritance
Implements
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public abstract class StackSynthesizer : DeputyBase, IStackSynthesizer
Syntax (vb)
Public MustInherit Class StackSynthesizer
Inherits DeputyBase
Implements IStackSynthesizer
Remarks
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.
Synopsis
Constructors
StackSynthesizer() | |
StackSynthesizer(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
StackSynthesizer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
AddDockerImageAsset(IDockerImageAssetSource) | Register a Docker Image Asset. |
AddFileAsset(IFileAssetSource) | Register a File Asset. |
Bind(Stack) | Bind to the stack this environment is going to be used on. |
EmitStackArtifact(Stack, ISynthesisSession, ISynthesizeStackArtifactOptions) | Write the stack artifact to the session. |
Synthesize(ISynthesisSession) | Synthesize the associated stack to the session. |
SynthesizeStackTemplate(Stack, ISynthesisSession) | Have the stack write out its template. |
Constructors
StackSynthesizer()
protected StackSynthesizer()
StackSynthesizer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected StackSynthesizer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
StackSynthesizer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected StackSynthesizer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Methods
AddDockerImageAsset(IDockerImageAssetSource)
Register a Docker Image Asset.
public abstract IDockerImageAssetLocation AddDockerImageAsset(IDockerImageAssetSource asset)
Parameters
- asset IDockerImageAssetSource
Returns
Remarks
Returns the parameters that can be used to refer to the asset inside the template.
AddFileAsset(IFileAssetSource)
Register a File Asset.
public abstract IFileAssetLocation AddFileAsset(IFileAssetSource asset)
Parameters
- asset IFileAssetSource
Returns
Remarks
Returns the parameters that can be used to refer to the asset inside the template.
Bind(Stack)
Bind to the stack this environment is going to be used on.
public abstract void Bind(Stack stack)
Parameters
- stack Stack
Remarks
Must be called before any of the other methods are called.
EmitStackArtifact(Stack, ISynthesisSession, ISynthesizeStackArtifactOptions)
Write the stack artifact to the session.
protected virtual void EmitStackArtifact(Stack stack, ISynthesisSession session, ISynthesizeStackArtifactOptions options = null)
Parameters
- stack Stack
- session ISynthesisSession
- options ISynthesizeStackArtifactOptions
Remarks
Use default settings to add a CloudFormationStackArtifact artifact to the given synthesis session.
Synthesize(ISynthesisSession)
Synthesize the associated stack to the session.
public abstract void Synthesize(ISynthesisSession session)
Parameters
- session ISynthesisSession
SynthesizeStackTemplate(Stack, ISynthesisSession)
Have the stack write out its template.
protected virtual void SynthesizeStackTemplate(Stack stack, ISynthesisSession session)
Parameters
- stack Stack
- session ISynthesisSession