software.amazon.awscdk

Interface StageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:45.956Z")
 @Stability(value=Experimental)
public interface StageProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Initialization props for a stage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StageProps.Builder A builder for StageProps
static class	StageProps.Jsii$Proxy An implementation for StageProps

Method Summary

Modifier and Type	Method and Description
static StageProps.Builder	builder()
default Environment	getEnv() (experimental) Default AWS environment (account/region) for `Stack`s in this `Stage`.
default String	getOutdir() (experimental) The output directory into which to emit synthesized artifacts.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEnv

@Stability(value=Experimental)
 @Nullable
default Environment getEnv()

(experimental) Default AWS environment (account/region) for `Stack`s in this `Stage`.

Stacks defined inside this Stage with either region or account missing from its env will use the corresponding field given here.

If either region or accountis is not configured for Stack (either on the Stack itself or on the containing Stage), the Stack will be environment-agnostic.

Environment-agnostic stacks can be deployed to any environment, may not be able to take advantage of all features of the CDK. For example, they will not be able to use environmental context lookups, will not automatically translate Service Principals to the right format based on the environment's AWS partition, and other such enhancements.

Default: - The environments should be configured on the `Stack`s.

Example:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 // Use a concrete account and region to deploy this Stage to
 // Use a concrete account and region to deploy this Stage to
 new Stage(app, "Stage1", new StageProps()
         .env(new Environment().account("123456789012").region("us-east-1")));
 // Use the CLI's current credentials to determine the target environment
 // Use the CLI's current credentials to determine the target environment
 new Stage(app, "Stage2", new StageProps()
         .env(new Environment().account(process.env.getCDK_DEFAULT_ACCOUNT()).region(process.env.getCDK_DEFAULT_REGION())));

getOutdir

@Stability(value=Experimental)
 @Nullable
default String getOutdir()

(experimental) The output directory into which to emit synthesized artifacts.

Can only be specified if this stage is the root stage (the app). If this is specified and this stage is nested within another stage, an error will be thrown.

Default: - for nested stages, outdir will be determined as a relative directory to the outdir of the app. For apps, if outdir is not specified, a temporary directory will be created.

builder

@Stability(value=Experimental)
static StageProps.Builder builder()

Returns:

a StageProps.Builder of StageProps