Package software.amazon.awscdk.core

Class StageProps.Builder

java.lang.Object

software.amazon.awscdk.core.StageProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StageProps>

Enclosing interface:

StageProps

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

A builder for StageProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StageProps	build()	Builds the configured instance.
StageProps.Builder	env(Environment env)	Sets the value of StageProps.getEnv()
StageProps.Builder	outdir(String outdir)	Sets the value of StageProps.getOutdir()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

env

@Stability(Stable)
public StageProps.Builder env(Environment env)

Sets the value of StageProps.getEnv()

Parameters:

env - Default AWS environment (account/region) for Stacks 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.

Returns:

this

outdir

@Stability(Stable)
public StageProps.Builder outdir(String outdir)

Sets the value of StageProps.getOutdir()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public StageProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StageProps

Throws:

NullPointerException - if any required attribute was not provided