software.amazon.awscdk.core

Class Stage

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Stage

All Implemented Interfaces:

IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

App

@Generated(value="jsii-pacmak/1.15.0 (build 585166b)",
           date="2020-12-12T01:56:06.292Z")
 @Stability(value=Stable)
public class Stage
extends Construct

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stage.Builder A fluent builder for Stage.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Stage(software.constructs.Construct scope, String id)
	Stage(software.constructs.Construct scope, String id, StageProps props)
protected	Stage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Stage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAccount() (experimental) The default account for all resources defined within this stage.
String	getArtifactId() (experimental) Artifact ID of the assembly if it is a nested stage.
String	getAssetOutdir() The cloud assembly asset output directory.
String	getOutdir() The cloud assembly output directory.
Stage	getParentStage() (experimental) The parent stage or `undefined` if this is the app.
String	getRegion() (experimental) The default region for all resources defined within this stage.
String	getStageName() (experimental) The name of the stage.
static Boolean	isStage(Object x) (experimental) Test whether the given construct is a stage.
static Stage	of(software.constructs.IConstruct construct) (experimental) Return the stage this construct is contained with, if available.
CloudAssembly	synth() Synthesize this stage into a cloud assembly.
CloudAssembly	synth(StageSynthesisOptions options) Synthesize this stage into a cloud assembly.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Stage

protected Stage(software.amazon.jsii.JsiiObjectRef objRef)

Stage

protected Stage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Stage

@Stability(value=Stable)
public Stage(@NotNull
                                      software.constructs.Construct scope,
                                      @NotNull
                                      String id,
                                      @Nullable
                                      StageProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Stage

@Stability(value=Stable)
public Stage(@NotNull
                                      software.constructs.Construct scope,
                                      @NotNull
                                      String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

isStage

@Stability(value=Experimental)
 @NotNull
public static Boolean isStage(@NotNull
                                                                       Object x)

(experimental) Test whether the given construct is a stage.

Parameters:

x - This parameter is required.

of

@Stability(value=Experimental)
 @Nullable
public static Stage of(@NotNull
                                                                 software.constructs.IConstruct construct)

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

If called on a nested stage, returns its parent.

Parameters:

construct - This parameter is required.

synth

@Stability(value=Stable)
 @NotNull
public CloudAssembly synth(@Nullable
                                                              StageSynthesisOptions options)

Synthesize this stage into a cloud assembly.

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

Parameters:

options -

synth

@Stability(value=Stable)
 @NotNull
public CloudAssembly synth()

Synthesize this stage into a cloud assembly.

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

getArtifactId

@Stability(value=Experimental)
 @NotNull
public String getArtifactId()

(experimental) 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.

getAssetOutdir

@Stability(value=Stable)
 @NotNull
public String getAssetOutdir()

The cloud assembly asset output directory.

getOutdir

@Stability(value=Stable)
 @NotNull
public String getOutdir()

The cloud assembly output directory.

getStageName

@Stability(value=Experimental)
 @NotNull
public String getStageName()

(experimental) The name of the stage.

Based on names of the parent stages separated by hypens.

getAccount

@Stability(value=Experimental)
 @Nullable
public String getAccount()

(experimental) The default account for all resources defined within this stage.

getParentStage

@Stability(value=Experimental)
 @Nullable
public Stage getParentStage()

(experimental) The parent stage or `undefined` if this is the app.

getRegion

@Stability(value=Experimental)
 @Nullable
public String getRegion()

(experimental) The default region for all resources defined within this stage.