Package software.amazon.awscdk

Class NestedStack.Builder

java.lang.Object
software.amazon.awscdk.NestedStack.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<NestedStack>
Enclosing class:
NestedStack
@Stability(Stable) public static final class NestedStack.Builder extends Object implements software.amazon.jsii.Builder<NestedStack>
A fluent builder for NestedStack.

  • Method Details

    • create

      @Stability(Stable) public static NestedStack.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of NestedStack.Builder.

    • description

      @Stability(Stable) public NestedStack.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

    • notificationArns

      @Stability(Stable) 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.

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

    • parameters

      @Stability(Stable) 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

      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

    • removalPolicy

      @Stability(Stable) public NestedStack.Builder removalPolicy(RemovalPolicy 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.

      Default: RemovalPolicy.DESTROY

      Parameters:
      removalPolicy - Policy to apply when the nested stack is removed. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Stable) 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

      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(Stable) public NestedStack build()
      Specified by:
      build in interface software.amazon.jsii.Builder<NestedStack>
      Returns:
      a newly built instance of NestedStack.