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

import { Stage } from '@alicloud/ros-cdk-core'
new Stage(scope: Construct, id: string, props?: StageProps)

Name	Type	Description
scope	Construct	No description.
id	string	No description.
props	StageProps	No description.

---

scope^Required

• Type: Construct

---

id^Required

• Type: string

---

props^Optional

• Type: StageProps

---

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

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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.

session^Required

• Type: ISynthesisSession

The synthesis session.

---

synth

public synth(options?: StageSynthesisOptions): CloudAssembly

Synthesize this stage into a cloud assembly.

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

options^Optional

• Type: StageSynthesisOptions

---

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

import { Stage } from '@alicloud/ros-cdk-core'
Stage.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

isStage

import { Stage } from '@alicloud/ros-cdk-core'
Stage.isStage(x: any)

Test whether the given construct is a stage.

x^Required

• Type: any

---

of

import { Stage } from '@alicloud/ros-cdk-core'
Stage.of(construct: IConstruct)

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

If called on a nested stage, returns its parent.

construct^Required

• Type: IConstruct

---

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.

---

node^Required

public readonly node: ConstructNode;

• Type: ConstructNode

The construct tree node associated with this construct.

---

artifactId^Required

public readonly artifactId: string;

• 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.

---

assetOutdir^Required

public readonly assetOutdir: string;

• Type: string

The cloud assembly asset output directory.

---

outdir^Required

public readonly outdir: string;

• Type: string

The cloud assembly output directory.

---

stageName^Required

public readonly stageName: string;

• Type: string

The name of the stage.

Based on names of the parent stages separated by hypens.

---

account^Optional

public readonly account: string;

• Type: string

The default account for all resources defined within this stage.

---

parentStage^Optional

public readonly parentStage: Stage;

• Type: Stage

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

*

---

region^Optional

public readonly region: string;

• Type: string

The default region for all resources defined within this stage.

---

Structs