software.amazon.awscdk.core

Class NestedStackProps.Builder

java.lang.Object

software.amazon.awscdk.core.NestedStackProps.Builder

Enclosing interface:

NestedStackProps

public static final class NestedStackProps.Builder
extends java.lang.Object

A builder for NestedStackProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
NestedStackProps	build() Builds the configured instance.
NestedStackProps.Builder	notificationArns(java.util.List<java.lang.String> notificationArns) Sets the value of NestedStackProps.getNotificationArns()
NestedStackProps.Builder	parameters(java.util.Map<java.lang.String,java.lang.String> parameters) Sets the value of NestedStackProps.getParameters()
NestedStackProps.Builder	removalPolicy(RemovalPolicy removalPolicy) Sets the value of NestedStackProps.getRemovalPolicy()
NestedStackProps.Builder	timeout(Duration timeout) Sets the value of NestedStackProps.getTimeout()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

notificationArns

public NestedStackProps.Builder notificationArns(java.util.List<java.lang.String> notificationArns)

Sets the value of NestedStackProps.getNotificationArns()

Parameters:

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

Returns:

this

parameters

public NestedStackProps.Builder parameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Sets the value of NestedStackProps.getParameters()

Parameters:

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.

Returns:

this

removalPolicy

public NestedStackProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of NestedStackProps.getRemovalPolicy()

Parameters:

removalPolicy - Policy to apply when the nested stack is removed. The default is Destroy, because all Removal Policies of resources inside the Nested Stack should already have been set correctly. You normally should not need to set this value.

Returns:

this

timeout

public NestedStackProps.Builder timeout(Duration timeout)

Sets the value of NestedStackProps.getTimeout()

Parameters:

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.

Returns:

this

build

public NestedStackProps build()

Builds the configured instance.

Returns:

a new instance of NestedStackProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided