class CfnStackPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CloudFormation.Mixins.CfnStackPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscloudformation/mixins#CfnStackPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.cloudformation.mixins.CfnStackPropsMixin
Python	aws_cdk.mixins_preview.aws_cloudformation.mixins.CfnStackPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_cloudformation » mixins » CfnStackPropsMixin

Implements IMixin

Extends Mixin

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

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 AWS::CloudFormation::Stack resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control to configure.

• NotificationARNs
• Parameters
• Tags
• TemplateURL
• TimeoutInMinutes

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 .

• Capabilities
• Description
• DisableRollback
• EnableTerminationProtection
• RoleARN
• StackName
• StackPolicyBody
• StackPolicyURL
• StackStatusReason
• TemplateBody

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 .

• ChangeSetId
• CreationTime
• LastUpdateTime
• Outputs
• ParentId
• RootId
• StackId
• StackStatus

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as cloudformation_mixins } from '@aws-cdk/mixins-preview/aws-cloudformation';
const cfnStackPropsMixin = new cloudformation_mixins.CfnStackPropsMixin({
  notificationArns: ['notificationArns'],
  parameters: {
    parametersKey: 'parameters',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  templateUrl: 'templateUrl',
  timeoutInMinutes: 123,
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnStackPropsMixin(props: CfnStackMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnStackMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnStackMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnStackMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.