Class CfnStackProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStackProps>
- Enclosing interface:
CfnStackProps
CfnStackProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.notificationArns
(List<String> notificationArns) Sets the value ofCfnStackProps.getNotificationArns()
parameters
(Map<String, String> parameters) Sets the value ofCfnStackProps.getParameters()
parameters
(IResolvable parameters) Sets the value ofCfnStackProps.getParameters()
Sets the value ofCfnStackProps.getTags()
templateUrl
(String templateUrl) Sets the value ofCfnStackProps.getTemplateUrl()
timeoutInMinutes
(Number timeoutInMinutes) Sets the value ofCfnStackProps.getTimeoutInMinutes()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
templateUrl
Sets the value ofCfnStackProps.getTemplateUrl()
- Parameters:
templateUrl
- Location of file containing the template body. This parameter is required. 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
-
notificationArns
Sets the value ofCfnStackProps.getNotificationArns()
- Parameters:
notificationArns
- The Amazon Simple Notification Service (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
Sets the value ofCfnStackProps.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 typeString
. In other words, you can't pass values that are of typeCommaDelimitedList
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
Sets the value ofCfnStackProps.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 typeString
. In other words, you can't pass values that are of typeCommaDelimitedList
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
Sets the value ofCfnStackProps.getTags()
- Parameters:
tags
- Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.- Returns:
this
-
timeoutInMinutes
Sets the value ofCfnStackProps.getTimeoutInMinutes()
- Parameters:
timeoutInMinutes
- The length of time, in minutes, that CloudFormation waits for the nested stack to reach theCREATE_COMPLETE
state. The default is no timeout. When CloudFormation detects that the nested stack has reached theCREATE_COMPLETE
state, it marks the nested stack resource asCREATE_COMPLETE
in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reachesCREATE_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
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnStackProps>
- Returns:
- a new instance of
CfnStackProps
- Throws:
NullPointerException
- if any required attribute was not provided
-