Class CfnStackPropsMixin

The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.

Inheritance

object

Mixin

CfnStackPropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.CloudFormation

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnStackPropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnStackPropsMixin Inherits Mixin Implements IMixin

Remarks

For more information, see Nested stacks in the CloudFormation User Guide .

You can add output values from a nested stack within the containing template. You use the GetAtt function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs. NestedStackOutputName .

We strongly recommend that updates to nested stacks are run from the parent stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.

For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see Controlling access with AWS Identity and Access Management in the CloudFormation User Guide .

A subset of <code>AWS::CloudFormation::Stack</code> resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control  to configure.

These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control .

Customers that configure AWS::CloudFormation::Stack using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.

These read-only properties can be accessed only when using Cloud Control .

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

CloudformationResource: AWS::CloudFormation::Stack

Mixin: true

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.CfnPropertyMixins.AWS.CloudFormation;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnStackPropsMixin = new CfnStackPropsMixin(new CfnStackMixinProps {
                 NotificationArns = new [] { "notificationArns" },
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateUrl = "templateUrl",
                 TimeoutInMinutes = 123
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Synopsis

Constructors

CfnStackPropsMixin(ICfnStackMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::CloudFormation::Stack.

Properties

CFN_PROPERTY_KEYS	The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Props	The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Strategy	The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnStackPropsMixin(ICfnStackMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::CloudFormation::Stack.

public CfnStackPropsMixin(ICfnStackMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnStackMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

For more information, see Nested stacks in the CloudFormation User Guide .

You can add output values from a nested stack within the containing template. You use the GetAtt function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs. NestedStackOutputName .

We strongly recommend that updates to nested stacks are run from the parent stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.

For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see Controlling access with AWS Identity and Access Management in the CloudFormation User Guide .

A subset of <code>AWS::CloudFormation::Stack</code> resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control  to configure.

These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control .

Customers that configure AWS::CloudFormation::Stack using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.

These read-only properties can be accessed only when using Cloud Control .

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

CloudformationResource: AWS::CloudFormation::Stack

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

For more information, see Nested stacks in the CloudFormation User Guide .

You can add output values from a nested stack within the containing template. You use the GetAtt function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs. NestedStackOutputName .

We strongly recommend that updates to nested stacks are run from the parent stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.

For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see Controlling access with AWS Identity and Access Management in the CloudFormation User Guide .

A subset of <code>AWS::CloudFormation::Stack</code> resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control  to configure.

These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control .

Customers that configure AWS::CloudFormation::Stack using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.

These read-only properties can be accessed only when using Cloud Control .

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

CloudformationResource: AWS::CloudFormation::Stack

Mixin: true

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.CfnPropertyMixins.AWS.CloudFormation;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnStackPropsMixin = new CfnStackPropsMixin(new CfnStackMixinProps {
                 NotificationArns = new [] { "notificationArns" },
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateUrl = "templateUrl",
                 TimeoutInMinutes = 123
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Props

The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.

protected virtual ICfnStackMixinProps Props { get; }

Property Value

ICfnStackMixinProps

Remarks

For more information, see Nested stacks in the CloudFormation User Guide .

You can add output values from a nested stack within the containing template. You use the GetAtt function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs. NestedStackOutputName .

We strongly recommend that updates to nested stacks are run from the parent stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.

For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see Controlling access with AWS Identity and Access Management in the CloudFormation User Guide .

A subset of <code>AWS::CloudFormation::Stack</code> resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control  to configure.

These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control .

Customers that configure AWS::CloudFormation::Stack using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.

These read-only properties can be accessed only when using Cloud Control .

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

CloudformationResource: AWS::CloudFormation::Stack

Mixin: true

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.CfnPropertyMixins.AWS.CloudFormation;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnStackPropsMixin = new CfnStackPropsMixin(new CfnStackMixinProps {
                 NotificationArns = new [] { "notificationArns" },
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateUrl = "templateUrl",
                 TimeoutInMinutes = 123
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Strategy

The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.

protected virtual IMergeStrategy Strategy { get; }

Property Value

IMergeStrategy

Remarks

For more information, see Nested stacks in the CloudFormation User Guide .

You can add output values from a nested stack within the containing template. You use the GetAtt function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs. NestedStackOutputName .

We strongly recommend that updates to nested stacks are run from the parent stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.

For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see Controlling access with AWS Identity and Access Management in the CloudFormation User Guide .

A subset of <code>AWS::CloudFormation::Stack</code> resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control  to configure.

These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control .

Customers that configure AWS::CloudFormation::Stack using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.

These read-only properties can be accessed only when using Cloud Control .

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

CloudformationResource: AWS::CloudFormation::Stack

Mixin: true

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.CfnPropertyMixins.AWS.CloudFormation;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnStackPropsMixin = new CfnStackPropsMixin(new CfnStackMixinProps {
                 NotificationArns = new [] { "notificationArns" },
                 Parameters = new Dictionary<string, string> {
                     { "parametersKey", "parameters" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TemplateUrl = "templateUrl",
                 TimeoutInMinutes = 123
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

For more information, see Nested stacks in the CloudFormation User Guide .

You can add output values from a nested stack within the containing template. You use the GetAtt function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs. NestedStackOutputName .

We strongly recommend that updates to nested stacks are run from the parent stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.

For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see Controlling access with AWS Identity and Access Management in the CloudFormation User Guide .

A subset of <code>AWS::CloudFormation::Stack</code> resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control  to configure.

These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control .

Customers that configure AWS::CloudFormation::Stack using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.

These read-only properties can be accessed only when using Cloud Control .

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

CloudformationResource: AWS::CloudFormation::Stack

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

Remarks

For more information, see Nested stacks in the CloudFormation User Guide .

You can add output values from a nested stack within the containing template. You use the GetAtt function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs. NestedStackOutputName .

We strongly recommend that updates to nested stacks are run from the parent stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.

For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see Controlling access with AWS Identity and Access Management in the CloudFormation User Guide .

A subset of <code>AWS::CloudFormation::Stack</code> resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control  to configure.

These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control .

Customers that configure AWS::CloudFormation::Stack using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.

These read-only properties can be accessed only when using Cloud Control .

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

CloudformationResource: AWS::CloudFormation::Stack

Mixin: true

ExampleMetadata: fixture=_generated

Implements

Constructs.IMixin