Skip to content

Stage

An abstract application modeling unit consisting of Stacks that should be deployed together.

Derive a subclass of 'Stage' and use it to model a single instance of your application.

You can then instantiate your subclass multiple times to model multiple copies of your application which should be be deployed to different environments.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Core;
new Stage(Construct Scope, string Id, StageProps Props = null);
Name Type Description
Scope Construct No description.
Id string No description.
Props StageProps No description.

ScopeRequired


IdRequired

  • Type: string

PropsOptional


Methods

Name Description
ToString Returns a string representation of this construct.
Synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
Synth Synthesize this stage into a cloud assembly.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

SessionRequired

The synthesis session.


Synth

private CloudAssembly Synth(StageSynthesisOptions Options = null)

Synthesize this stage into a cloud assembly.

Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.

OptionsOptional


Static Functions

Name Description
IsConstruct Return whether the given object is a Construct.
IsStage Test whether the given construct is a stage.
Of Return the stage this construct is contained with, if available.

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Core;
Stage.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

IsStage

using AlibabaCloud.SDK.ROS.CDK.Core;
Stage.IsStage(object X);

Test whether the given construct is a stage.

XRequired

  • Type: object

Of

using AlibabaCloud.SDK.ROS.CDK.Core;
Stage.Of(IConstruct Construct);

Return the stage this construct is contained with, if available.

If called on a nested stage, returns its parent.

ConstructRequired


Properties

Name Type Description
Node ConstructNode The construct tree node associated with this construct.
ArtifactId string Artifact ID of the assembly if it is a nested stage. The root stage app will return an empty string.
AssetOutdir string The cloud assembly asset output directory.
Outdir string The cloud assembly output directory.
StageName string The name of the stage.
Account string The default account for all resources defined within this stage.
ParentStage Stage The parent stage or 'undefined' if this is the app.
Region string The default region for all resources defined within this stage.

NodeRequired

public ConstructNode Node { get; }

The construct tree node associated with this construct.


ArtifactIdRequired

public string ArtifactId { get; }
  • Type: string

Artifact ID of the assembly if it is a nested stage. The root stage app will return an empty string.

Derived from the construct path.


AssetOutdirRequired

public string AssetOutdir { get; }
  • Type: string

The cloud assembly asset output directory.


OutdirRequired

public string Outdir { get; }
  • Type: string

The cloud assembly output directory.


StageNameRequired

public string StageName { get; }
  • Type: string

The name of the stage.

Based on names of the parent stages separated by hypens.


AccountOptional

public string Account { get; }
  • Type: string

The default account for all resources defined within this stage.


ParentStageOptional

public Stage ParentStage { get; }

The parent stage or 'undefined' if this is the app.

*


RegionOptional

public string Region { get; }
  • Type: string

The default region for all resources defined within this stage.


Structs