Show / Hide Table of Contents

Class CfnStackProps

Properties for defining a CfnStack.

Inheritance
System.Object
CfnStackProps
Implements
ICfnStackProps
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStackProps : Object, ICfnStackProps
Syntax (vb)
Public Class CfnStackProps
    Inherits Object
    Implements ICfnStackProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// 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
};

Synopsis

Constructors

CfnStackProps()

Properties

NotificationArns

The Amazon SNS topic ARNs to publish stack related events.

Parameters

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

Tags

Key-value pairs to associate with this stack.

TemplateUrl

The URL of a file containing the template body.

TimeoutInMinutes

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

Constructors

CfnStackProps()

public CfnStackProps()

Properties

NotificationArns

The Amazon SNS topic ARNs to publish stack related events.

public string[] NotificationArns { get; set; }
Property Value

System.String[]

Remarks

You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).

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

Parameters

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

public object Parameters { get; set; }
Property Value

System.Object

Remarks

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.

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

Tags

Key-value pairs to associate with this stack.

public ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

Remarks

CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

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

TemplateUrl

The URL of a file containing the template body.

public string TemplateUrl { get; set; }
Property Value

System.String

Remarks

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.

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

TimeoutInMinutes

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

public Nullable<double> TimeoutInMinutes { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-timeoutinminutes

Implements

ICfnStackProps
Back to top Generated by DocFX