software.amazon.awscdk.core

Class Stack.Builder

java.lang.Object

software.amazon.awscdk.core.Stack.Builder

Enclosing class:

Stack

@Stability(value=Stable)
public static final class Stack.Builder
extends Object

A fluent builder for Stack.

Method Summary

Modifier and Type	Method and Description
Stack	build()
static Stack.Builder	create()
static Stack.Builder	create(Construct scope)
static Stack.Builder	create(Construct scope, String id)
Stack.Builder	description(String description) A description of the stack.
Stack.Builder	env(Environment env) The AWS environment (account/region) where this stack will be deployed.
Stack.Builder	stackName(String stackName) Name to deploy the stack with.
Stack.Builder	synthesizer(IStackSynthesizer synthesizer) Synthesis method to use while deploying this stack.
Stack.Builder	tags(Map<String,String> tags) Stack tags that will be applied to all the taggable resources and the stack itself.
Stack.Builder	terminationProtection(Boolean terminationProtection) Whether to enable termination protection for this stack.

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 Stack.Builder create(Construct scope,
                                                            String id)

Parameters:

scope - Parent of this stack, usually a Program instance.

id - The construct ID of this stack.

Returns:

a new instance of Stack.Builder.

create

@Stability(value=Stable)
public static Stack.Builder create(Construct scope)

Parameters:

scope - Parent of this stack, usually a Program instance.

Returns:

a new instance of Stack.Builder.

create

@Stability(value=Stable)
public static Stack.Builder create()

Returns:

a new instance of Stack.Builder.

description

@Stability(value=Stable)
public Stack.Builder description(String description)

A description of the stack.

Default: - No description.

Parameters:

description - A description of the stack. This parameter is required.

Returns:

this

env

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

The AWS environment (account/region) where this stack will be deployed.

Default: - The `default-account` and `default-region` context parameters will be used. If they are undefined, it will not be possible to deploy the stack.

Parameters:

env - The AWS environment (account/region) where this stack will be deployed. This parameter is required.

Returns:

this

stackName

@Stability(value=Stable)
public Stack.Builder stackName(String stackName)

Name to deploy the stack with.

Default: - Derived from construct path.

Parameters:

stackName - Name to deploy the stack with. This parameter is required.

Returns:

this

synthesizer

@Stability(value=Stable)
public Stack.Builder synthesizer(IStackSynthesizer synthesizer)

Synthesis method to use while deploying this stack.

Default: - `DefaultStackSynthesizer` if the `@aws-cdk/core:newStyleStackSynthesis` feature flag is set, `LegacyStackSynthesizer` otherwise.

Parameters:

synthesizer - Synthesis method to use while deploying this stack. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public Stack.Builder tags(Map<String,String> tags)

Stack tags that will be applied to all the taggable resources and the stack itself.

Default: {}

Parameters:

tags - Stack tags that will be applied to all the taggable resources and the stack itself. This parameter is required.

Returns:

this

terminationProtection

@Stability(value=Stable)
public Stack.Builder terminationProtection(Boolean terminationProtection)

Whether to enable termination protection for this stack.

Default: false

Parameters:

terminationProtection - Whether to enable termination protection for this stack. This parameter is required.

Returns:

this

build

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