@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:55.210Z")
public interface CfnStackProps
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cloudformation.*; CfnStackProps cfnStackProps = CfnStackProps.builder() .templateUrl("templateUrl") // the properties below are optional .notificationArns(List.of("notificationArns")) .parameters(Map.of( "parametersKey", "parameters")) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .timeoutInMinutes(123) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnStackProps.Builder
A builder for
CfnStackProps |
static class |
CfnStackProps.Jsii$Proxy
An implementation for
CfnStackProps |
Modifier and Type | Method and Description |
---|---|
static CfnStackProps.Builder |
builder() |
default java.util.List<java.lang.String> |
getNotificationArns()
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events.
|
default java.lang.Object |
getParameters()
The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
|
default java.util.List<CfnTag> |
getTags()
Key-value pairs to associate with this stack.
|
java.lang.String |
getTemplateUrl()
Location of file containing the template body.
|
default java.lang.Number |
getTimeoutInMinutes()
The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state.
|
java.lang.String getTemplateUrl()
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.
default java.util.List<java.lang.String> getNotificationArns()
You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
default java.lang.Object getParameters()
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.
default java.util.List<CfnTag> getTags()
AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
default java.lang.Number getTimeoutInMinutes()
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.
static CfnStackProps.Builder builder()
CfnStackProps.Builder
of CfnStackProps