Class CfnStack.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStack>
- Enclosing class:
CfnStack
CfnStack
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static CfnStack.Builder
notificationArns
(List<String> notificationArns) The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events.parameters
(Map<String, String> parameters) The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.parameters
(IResolvable parameters) The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.Key-value pairs to associate with this stack.templateUrl
(String templateUrl) Location of file containing the template body.timeoutInMinutes
(Number timeoutInMinutes) The length of time, in minutes, that CloudFormation waits for the nested stack to reach theCREATE_COMPLETE
state.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnStack.Builder
.
-
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.
- Parameters:
templateUrl
- Location of file containing the template body. This parameter is required.- Returns:
this
-
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).
- Parameters:
notificationArns
- The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. This parameter is required.- Returns:
this
-
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.
- 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
-
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.
- 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
-
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.
- Parameters:
tags
- Key-value pairs to associate with this stack. This parameter is required.- Returns:
this
-
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 the
CREATE_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.
- Parameters:
timeoutInMinutes
- The length of time, in minutes, that CloudFormation waits for the nested stack to reach theCREATE_COMPLETE
state. This parameter is required.- Returns:
this
-
build
-