CfnStackProps Struct

Properties for defining a CfnStack.

Source: Generated code
Type last changed: v2.106.0 · 10 Nov 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const cfnStackProps: cdk.CfnStackProps = {
  notificationArns: ['notificationArns'],
  parameters: {
    parametersKey: 'parameters',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  templateUrl: 'templateUrl',
  timeoutInMinutes: 123,
};

python

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk

cfn_stack_props = cdk.CfnStackProps(
    notification_arns=["notificationArns"],
    parameters={
        "parameters_key": "parameters"
    },
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    template_url="templateUrl",
    timeout_in_minutes=123
)

java

// 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();

csharp

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;

var cfnStackProps = new CfnStackProps {
    NotificationArns = new [] { "notificationArns" },
    Parameters = new Dictionary<string, string> {
        { "parametersKey", "parameters" }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TemplateUrl = "templateUrl",
    TimeoutInMinutes = 123
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"

cfnStackProps := &CfnStackProps{
	NotificationArns: []*string{
		jsii.String("notificationArns"),
	},
	Parameters: map[string]*string{
		"parametersKey": jsii.String("parameters"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	TemplateUrl: jsii.String("templateUrl"),
	TimeoutInMinutes: jsii.Number(123),
}

Properties

notificationArnsoptionalstring[]notification_arnsoptionaltyping.List[str]notificationArnsoptionalList<String>NotificationArnsoptionalstring[]NotificationArnsoptional*[]*string#

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

parametersoptionalIResolvable | { [key: string]: string }parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]parametersoptionalIResolvableParametersoptionalIResolvableParametersoptionalinterface{}#

The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.

notes

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.

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.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#

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.

templateUrloptionalstringtemplate_urloptionalstrtemplateUrloptionalStringTemplateUrloptionalstringTemplateUrloptional*string#

The URL of a file that contains the template body.

notes

The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket. The location for an Amazon S3 bucket must start with https:// .

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

timeoutInMinutesoptionalnumbertimeout_in_minutesoptionalint | floattimeoutInMinutesoptionalNumberTimeoutInMinutesoptionaldoubleTimeoutInMinutesoptional*float64#

The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state.

notes

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.

CfnStackProps Struct ​

Example ​

Properties ​

CfnStackProps Struct

Example

Properties