software.amazon.awscdk.core

Class NestedStack.Builder

java.lang.Object

software.amazon.awscdk.core.NestedStack.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<NestedStack>

Enclosing class:

NestedStack

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

A fluent builder for NestedStack.

Method Summary

Modifier and Type	Method and Description
NestedStack	build()
static NestedStack.Builder	create(Construct scope, String id) EXPERIMENTAL
NestedStack.Builder	notificationArns(List<String> notificationArns) The Simple Notification Service (SNS) topics to publish stack related events.
NestedStack.Builder	parameters(Map<String,String> parameters) The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
NestedStack.Builder	timeout(Duration timeout) The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static NestedStack.Builder create(Construct scope,
                                                                        String id)

EXPERIMENTAL

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of NestedStack.Builder.

notificationArns

@Stability(value=Experimental)
public NestedStack.Builder notificationArns(List<String> notificationArns)

The Simple Notification Service (SNS) topics to publish stack related events.

Default: - notifications are not sent for this stack.

EXPERIMENTAL

Parameters:

notificationArns - The Simple Notification Service (SNS) topics to publish stack related events. This parameter is required.

Returns:

this

parameters

@Stability(value=Experimental)
public NestedStack.Builder parameters(Map<String,String> parameters)

The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.

Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.

The nested stack construct will automatically synthesize parameters in order to bind references from the parent stack(s) into the nested stack.

Default: - no user-defined parameters are passed to the nested stack

EXPERIMENTAL

Parameters:

parameters - The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. This parameter is required.

Returns:

this

timeout

@Stability(value=Experimental)
public NestedStack.Builder timeout(Duration timeout)

The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

When CloudFormation detects that the nested stack has reached the CREATE_COMPLETE state, it marks the nested stack resource as CREATE_COMPLETE in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches CREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.

Default: - no timeout

EXPERIMENTAL

Parameters:

timeout - The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public NestedStack build()

Specified by:

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