software.amazon.awscdk.core

Class Stage.Builder

java.lang.Object

software.amazon.awscdk.core.Stage.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Stage>

Enclosing class:

Stage

@Stability(value=Stable)
public static final class Stage.Builder
extends Object
implements software.amazon.jsii.Builder<Stage>

A fluent builder for Stage.

Method Summary

Modifier and Type	Method and Description
Stage	build()
static Stage.Builder	create(software.constructs.Construct scope, String id)
Stage.Builder	env(Environment env) Default AWS environment (account/region) for `Stack`s in this `Stage`.
Stage.Builder	outdir(String outdir) The output directory into which to emit synthesized artifacts.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Stage.Builder.

env

@Stability(value=Stable)
public Stage.Builder env(Environment env)

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
 MyStage.Builder.create(app, "Stage1")
         .env(Map.of("account", "123456789012", "region", "us-east-1"))
         .build();
 // Use the CLI's current credentials to determine the target environment
 // Use the CLI's current credentials to determine the target environment
 MyStage.Builder.create(app, "Stage2")
         .env(Map.of("account", process.env.getCDK_DEFAULT_ACCOUNT(), "region", process.env.getCDK_DEFAULT_REGION()))
         .build();

Parameters:

env - Default AWS environment (account/region) for `Stack`s in this `Stage`. This parameter is required.

Returns:

this

outdir

@Stability(value=Stable)
public Stage.Builder outdir(String outdir)

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.

Parameters:

outdir - The output directory into which to emit synthesized artifacts. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public Stage build()

Specified by:

build in interface software.amazon.jsii.Builder<Stage>