Package software.amazon.awscdk

Interface CfnStackProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStackProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:55.736Z")
@Stability(Stable)
public interface CfnStackProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStack.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 CfnStackProps cfnStackProps = CfnStackProps.builder()
         .notificationArns(List.of("notificationArns"))
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateUrl("templateUrl")
         .timeoutInMinutes(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStackProps.Builder	A builder for CfnStackProps
static final class	CfnStackProps.Jsii$Proxy	An implementation for CfnStackProps

Method Summary

Modifier and Type	Method	Description
static CfnStackProps.Builder	builder()
default List<String>	getNotificationArns()	The Amazon SNS topic ARNs to publish stack related events.
default Object	getParameters()	The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.
default List<CfnTag>	getTags()	Key-value pairs to associate with this stack.
default String	getTemplateUrl()	Location of file containing the template body.
default Number	getTimeoutInMinutes()	The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNotificationArns

@Stability(Stable)
@Nullable
default List<String> getNotificationArns()

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).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-notificationarns

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-parameters

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-tags

getTemplateUrl

@Stability(Stable)
@Nullable
default String getTemplateUrl()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-templateurl

getTimeoutInMinutes

@Stability(Stable)
@Nullable
default Number getTimeoutInMinutes()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-timeoutinminutes

builder

@Stability(Stable)
static CfnStackProps.Builder builder()

Returns:

a CfnStackProps.Builder of CfnStackProps