Package software.amazon.awscdk

Class CfnStackProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • notificationArns

      @Stability(Stable) public CfnStackProps.Builder notificationArns(List<String> notificationArns)
      Sets the value of CfnStackProps.getNotificationArns()
      Parameters:
      notificationArns - The Amazon SNS topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnStackProps.Builder parameters(IResolvable parameters)
      Sets the value of CfnStackProps.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.

      If you use the Ref function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type String . In other words, you can't pass values that are of type CommaDelimitedList to nested stacks.

      Conditional. Required if the nested stack requires input parameters.

      Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.

      Returns:
      this

    • parameters

      @Stability(Stable) public CfnStackProps.Builder parameters(Map<String,String> parameters)
      Sets the value of CfnStackProps.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.

      If you use the Ref function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type String . In other words, you can't pass values that are of type CommaDelimitedList to nested stacks.

      Conditional. Required if the nested stack requires input parameters.

      Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnStackProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnStackProps.getTags()
      Parameters:
      tags - Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
      Returns:
      this

    • templateUrl

      @Stability(Stable) public CfnStackProps.Builder templateUrl(String templateUrl)
      Sets the value of CfnStackProps.getTemplateUrl()
      Parameters:
      templateUrl - Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template anatomy .

      Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.

      Returns:
      this

    • timeoutInMinutes

      @Stability(Stable) public CfnStackProps.Builder timeoutInMinutes(Number timeoutInMinutes)
      Sets the value of CfnStackProps.getTimeoutInMinutes()
      Parameters:
      timeoutInMinutes - The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state. The default is no timeout. 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.

      Updates aren't supported.

      Returns:
      this

    • build

      @Stability(Stable) public CfnStackProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnStackProps>
      Returns:
      a new instance of CfnStackProps
      Throws:
      NullPointerException - if any required attribute was not provided