Class CfnStackMixinProps

Properties for CfnStackPropsMixin.

Inheritance

object

CfnStackMixinProps

Implements

ICfnStackMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.CloudFormation.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnStackMixinProps : ICfnStackMixinProps

Syntax (vb)

Public Class CfnStackMixinProps Implements ICfnStackMixinProps

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.Mixins.Preview.AWS.CloudFormation.Mixins;

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

Synopsis

Constructors

CfnStackMixinProps()

Properties for CfnStackPropsMixin.

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 that contains the template body.
TimeoutInMinutes	The length of time, in minutes, that CloudFormation waits for the nested stack to reach the `CREATE_COMPLETE` state.

Constructors

CfnStackMixinProps()

Properties for CfnStackPropsMixin.

public CfnStackMixinProps()

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.Mixins.Preview.AWS.CloudFormation.Mixins;

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

Properties

NotificationArns

The Amazon SNS topic ARNs to publish stack related events.

public string[]? NotificationArns { get; set; }

Property Value

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

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 <code>Ref</code> function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type <code>String</code> . In other words, you can't pass values that are of type <code>CommaDelimitedList</code> 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

Type union: either Dictionary<string, string> or IResolvable

TemplateUrl

The URL of a file that contains the template body.

public string? TemplateUrl { get; set; }

Property Value

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 double? TimeoutInMinutes { get; set; }

Property Value

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

ICfnStackMixinProps