software.amazon.awscdk

Interface NestedStackProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NestedStackProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:44.842Z")
 @Stability(value=Experimental)
public interface NestedStackProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Initialization props for the `NestedStack` construct.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NestedStackProps.Builder A builder for NestedStackProps
static class	NestedStackProps.Jsii$Proxy An implementation for NestedStackProps

Method Summary

Modifier and Type	Method and Description
static NestedStackProps.Builder	builder()
default List<String>	getNotificationArns() (experimental) The Simple Notification Service (SNS) topics to publish stack related events.
default Map<String,String>	getParameters() (experimental) The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
default RemovalPolicy	getRemovalPolicy() (experimental) Policy to apply when the nested stack is removed.
default Duration	getTimeout() (experimental) The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNotificationArns

@Stability(value=Experimental)
 @Nullable
default List<String> getNotificationArns()

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

Default: - notifications are not sent for this stack.

getParameters

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getParameters()

(experimental) 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

getRemovalPolicy

@Stability(value=Experimental)
 @Nullable
default RemovalPolicy getRemovalPolicy()

(experimental) 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.

Default: RemovalPolicy.DESTROY

getTimeout

@Stability(value=Experimental)
 @Nullable
default Duration getTimeout()

(experimental) 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

builder

@Stability(value=Experimental)
static NestedStackProps.Builder builder()

Returns:

a NestedStackProps.Builder of NestedStackProps