Class NestedStackSynthesizer
Synthesizer for a nested stack.
Implements
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class NestedStackSynthesizer : StackSynthesizer, IStackSynthesizer
Syntax (vb)
Public Class NestedStackSynthesizer
Inherits StackSynthesizer
Implements IStackSynthesizer
Remarks
Forwards all calls to the parent stack's synthesizer.
This synthesizer is automatically used for NestedStack
constructs.
App builder do not need to use this class directly.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
StackSynthesizer stackSynthesizer;
var nestedStackSynthesizer = new NestedStackSynthesizer(stackSynthesizer);
Synopsis
Constructors
NestedStackSynthesizer(IStackSynthesizer) | |
NestedStackSynthesizer(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
NestedStackSynthesizer(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
BootstrapQualifier | The qualifier used to bootstrap this stack. |
LookupRole | The role used to lookup for this stack. |
Methods
AddDockerImageAsset(IDockerImageAssetSource) | Register a Docker Image Asset. |
AddFileAsset(IFileAssetSource) | Register a File Asset. |
Synthesize(ISynthesisSession) | Synthesize the associated stack to the session. |
Constructors
NestedStackSynthesizer(IStackSynthesizer)
public NestedStackSynthesizer(IStackSynthesizer parentDeployment)
Parameters
- parentDeployment IStackSynthesizer
NestedStackSynthesizer(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected NestedStackSynthesizer(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
NestedStackSynthesizer(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected NestedStackSynthesizer(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
BootstrapQualifier
The qualifier used to bootstrap this stack.
public override string BootstrapQualifier { get; }
Property Value
System.String
Overrides
LookupRole
The role used to lookup for this stack.
public override string LookupRole { get; }
Property Value
System.String
Overrides
Methods
AddDockerImageAsset(IDockerImageAssetSource)
Register a Docker Image Asset.
public override IDockerImageAssetLocation AddDockerImageAsset(IDockerImageAssetSource asset)
Parameters
- asset IDockerImageAssetSource
Returns
Overrides
Remarks
Returns the parameters that can be used to refer to the asset inside the template.
The synthesizer must rely on some out-of-band mechanism to make sure the given files
are actually placed in the returned location before the deployment happens. This can
be by writing the instructions to the asset manifest (for use by the cdk-assets
tool),
by relying on the CLI to upload files (legacy behavior), or some other operator controlled
mechanism.
AddFileAsset(IFileAssetSource)
Register a File Asset.
public override IFileAssetLocation AddFileAsset(IFileAssetSource asset)
Parameters
- asset IFileAssetSource
Returns
Overrides
Remarks
Returns the parameters that can be used to refer to the asset inside the template.
The synthesizer must rely on some out-of-band mechanism to make sure the given files
are actually placed in the returned location before the deployment happens. This can
be by writing the instructions to the asset manifest (for use by the cdk-assets
tool),
by relying on the CLI to upload files (legacy behavior), or some other operator controlled
mechanism.
Synthesize(ISynthesisSession)
Synthesize the associated stack to the session.
public override void Synthesize(ISynthesisSession session)
Parameters
- session ISynthesisSession