Rename 'nestedStacks' to 'includeNestedStacks' for consistency.

Author: skinny85

packages/@aws-cdk/cloudformation-include/README.md

@@ -274,7 +274,7 @@ and the nested stack in your CDK application as follows:
 ```typescript
 const parentTemplate = new inc.CfnInclude(this, 'ParentStack', {
   templateFile: 'path/to/my-parent-template.json',
-  nestedStacks: {
+  includeNestedStacks: {
     'ChildStack': {
       templateFile: 'path/to/my-nested-template.json',
     },

packages/@aws-cdk/cloudformation-include/lib/cfn-include.ts

@@ -40,7 +40,7 @@ export interface CfnIncludeProps {
    *
    * @default - no nested stacks will be included
    */
-  readonly nestedStacks?: { [stackName: string]: CfnIncludeProps };
+  readonly includeNestedStacks?: { [stackName: string]: CfnIncludeProps };
 
   /**
    * Specifies parameters to be replaced by the values in this mapping.
@@ -134,13 +134,13 @@ export class CfnInclude extends core.CfnElement {
       this.createRule(ruleName);
     }
 
-    this.nestedStacksToInclude = props.nestedStacks || {};
+    this.nestedStacksToInclude = props.includeNestedStacks || {};
     // instantiate all resources as CDK L1 objects
     for (const logicalId of Object.keys(this.template.Resources || {})) {
       this.getOrCreateResource(logicalId);
     }
     // verify that all nestedStacks have been instantiated
-    for (const nestedStackId of Object.keys(props.nestedStacks || {})) {
+    for (const nestedStackId of Object.keys(props.includeNestedStacks || {})) {
       if (!(nestedStackId in this.resources)) {
         throw new Error(`Nested Stack with logical ID '${nestedStackId}' was not found in the template`);
       }
@@ -293,7 +293,7 @@ export class CfnInclude extends core.CfnElement {
    * Includes a template for a child stack inside of this parent template.
    * A child with this logical ID must exist in the template,
    * and be of type AWS::CloudFormation::Stack.
-   * This is equivalent to specifying the value in the {@link CfnIncludeProps.nestedStacks}
+   * This is equivalent to specifying the value in the {@link CfnIncludeProps.includeNestedStacks}
    * property on object construction.
    *
    * @param logicalId the ID of the stack to retrieve, as it appears in the template
@@ -343,7 +343,7 @@ export class CfnInclude extends core.CfnElement {
   /**
    * Returns the NestedStack with name logicalId.
    * For a nested stack to be returned by this method,
-   * it must be specified either in the {@link CfnIncludeProps.nestedStacks} property,
+   * it must be specified either in the {@link CfnIncludeProps.includeNestedStacks} property,
    * or through the {@link includeNestedStack} method.
    *
    * @param logicalId the ID of the stack to retrieve, as it appears in the template
@@ -355,7 +355,7 @@ export class CfnInclude extends core.CfnElement {
       } else if (this.template.Resources[logicalId].Type !== 'AWS::CloudFormation::Stack') {
         throw new Error(`Resource with logical ID '${logicalId}' is not a CloudFormation Stack`);
       } else {
-        throw new Error(`Nested Stack '${logicalId}' was not included in the nestedStacks property when including the parent template`);
+        throw new Error(`Nested Stack '${logicalId}' was not included in the includeNestedStacks property when including the parent template`);
       }
     }
     return this.nestedStacks[logicalId];

packages/@aws-cdk/cloudformation-include/package.json

@@ -332,7 +332,7 @@
   },
   "awslint": {
     "exclude": [
-      "props-no-cfn-types:@aws-cdk/cloudformation-include.CfnIncludeProps.nestedStacks"
+      "props-no-cfn-types:@aws-cdk/cloudformation-include.CfnIncludeProps.includeNestedStacks"
     ]
   },
   "stability": "experimental",

packages/@aws-cdk/cloudformation-include/test/integ.nested-stacks.ts

@@ -7,7 +7,7 @@ const stack = new core.Stack(app, 'ParentStack');
 
 new inc.CfnInclude(stack, 'ParentStack', {
   templateFile: 'test-templates/nested/parent-one-child.json',
-  nestedStacks: {
+  includeNestedStacks: {
     ChildStack: {
       templateFile: 'test-templates/nested/grandchild-import-stack.json',
     },

packages/@aws-cdk/cloudformation-include/test/nested-stacks.test.ts

@@ -19,7 +19,7 @@ describe('CDK Include for nested stacks', () => {
   test('can ingest a template with one child', () => {
     const parentTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-one-child.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('grandchild-import-stack.json'),
         },
@@ -35,7 +35,7 @@ describe('CDK Include for nested stacks', () => {
   test('can ingest a template with two children', () => {
     const parentTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-two-children.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('grandchild-import-stack.json'),
         },
@@ -59,10 +59,10 @@ describe('CDK Include for nested stacks', () => {
   test('can ingest a template with one child and one grandchild', () => {
     const parentTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-two-children.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('child-import-stack.json'),
-          nestedStacks: {
+          includeNestedStacks: {
             'GrandChildStack': {
               templateFile: testTemplateFilePath('grandchild-import-stack.json'),
             },
@@ -86,7 +86,7 @@ describe('CDK Include for nested stacks', () => {
     expect(() => {
       new inc.CfnInclude(stack, 'ParentStack', {
         templateFile: testTemplateFilePath('parent-two-children.json'),
-        nestedStacks: {
+        includeNestedStacks: {
           'FakeStack': {
             templateFile: testTemplateFilePath('child-import-stack.json'),
           },
@@ -99,7 +99,7 @@ describe('CDK Include for nested stacks', () => {
     expect(() => {
       new inc.CfnInclude(stack, 'ParentStack', {
         templateFile: testTemplateFilePath('child-import-stack.json'),
-        nestedStacks: {
+        includeNestedStacks: {
           'BucketImport': {
             templateFile: testTemplateFilePath('grandchild-import-stack.json'),
           },
@@ -112,7 +112,7 @@ describe('CDK Include for nested stacks', () => {
     expect(() => {
       new inc.CfnInclude(stack, 'ParentStack', {
         templateFile: testTemplateFilePath('parent-creation-policy.json'),
-        nestedStacks: {
+        includeNestedStacks: {
           'ChildStack': {
             templateFile: testTemplateFilePath('grandchild-import-stack.json'),
           },
@@ -125,7 +125,7 @@ describe('CDK Include for nested stacks', () => {
     expect(() => {
       new inc.CfnInclude(stack, 'ParentStack', {
         templateFile: testTemplateFilePath('parent-update-policy.json'),
-        nestedStacks: {
+        includeNestedStacks: {
           'ChildStack': {
             templateFile: testTemplateFilePath('grandchild-import-stack.json'),
           },
@@ -138,7 +138,7 @@ describe('CDK Include for nested stacks', () => {
     expect(() => {
       new inc.CfnInclude(stack, 'ParentStack', {
         templateFile: testTemplateFilePath('parent-invalid-condition.json'),
-        nestedStacks: {
+        includeNestedStacks: {
           'ChildStack': {
             templateFile: testTemplateFilePath('grandchild-import-stack.json'),
           },
@@ -151,7 +151,7 @@ describe('CDK Include for nested stacks', () => {
     expect(() => {
       new inc.CfnInclude(stack, 'ParentStack', {
         templateFile: testTemplateFilePath('parent-bad-depends-on.json'),
-        nestedStacks: {
+        includeNestedStacks: {
           'ChildStack': {
             templateFile: testTemplateFilePath('child-import-stack.json'),
           },
@@ -160,11 +160,11 @@ describe('CDK Include for nested stacks', () => {
     }).toThrow(/Resource 'ChildStack' depends on 'AFakeResource' that doesn't exist/);
   });
 
-  test('throws an exception when an ID was passed in nestedStacks that is a resource type not in the CloudFormation schema', () => {
+  test('throws an exception when an ID was passed in includeNestedStacks that is a resource type not in the CloudFormation schema', () => {
     expect(() => {
       new inc.CfnInclude(stack, 'Template', {
         templateFile: testTemplateFilePath('custom-resource.json'),
-        nestedStacks: {
+        includeNestedStacks: {
           'CustomResource': {
             templateFile: testTemplateFilePath('whatever.json'),
           },
@@ -176,7 +176,7 @@ describe('CDK Include for nested stacks', () => {
   test('can modify resources in nested stacks', () => {
     const parent = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('child-import-stack.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'GrandChildStack': {
           templateFile: testTemplateFilePath('grandchild-import-stack.json'),
         },
@@ -194,7 +194,7 @@ describe('CDK Include for nested stacks', () => {
   test('can use a condition', () => {
     const parent = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-valid-condition.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('grandchild-import-stack.json'),
         },
@@ -209,7 +209,7 @@ describe('CDK Include for nested stacks', () => {
   test('asset parameters generated in parent and child are identical', () => {
     new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-one-child.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('grandchild-import-stack.json'),
         },
@@ -279,7 +279,7 @@ describe('CDK Include for nested stacks', () => {
     });
   });
 
-  test('templates with nested stacks that were not provided in the nestedStacks property are left unmodified', () => {
+  test('templates with nested stacks that were not provided in the includeNestedStacks property are left unmodified', () => {
     new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-two-children.json'),
     });
@@ -290,7 +290,7 @@ describe('CDK Include for nested stacks', () => {
   test('getNestedStack() throws an exception when getting a resource that does not exist in the template', () => {
     const parentTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-two-children.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('child-import-stack.json'),
         },
@@ -305,7 +305,7 @@ describe('CDK Include for nested stacks', () => {
   test('getNestedStack() throws an exception when getting a resource that exists in the template, but is not a Stack', () => {
     const parentTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-two-children.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('child-import-stack.json'),
         },
@@ -322,7 +322,7 @@ describe('CDK Include for nested stacks', () => {
   test('getNestedStack() throws an exception when getting a resource that exists in the template, but was not specified in the props', () => {
     const parentTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-two-children.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('child-import-stack.json'),
         },
@@ -331,13 +331,13 @@ describe('CDK Include for nested stacks', () => {
 
     expect(() => {
       parentTemplate.getNestedStack('AnotherChildStack');
-    }).toThrow(/Nested Stack 'AnotherChildStack' was not included in the nestedStacks property when including the parent template/);
+    }).toThrow(/Nested Stack 'AnotherChildStack' was not included in the includeNestedStacks property when including the parent template/);
   });
 
   test('correctly handles renaming of references across nested stacks', () => {
     const parentTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('cross-stack-refs.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('child-import-stack.json'),
         },
@@ -360,7 +360,7 @@ describe('CDK Include for nested stacks', () => {
     });
   });
 
-  test('returns the CfnStack object from getResource() for a nested stack that was not in the nestedStacks property', () => {
+  test('returns the CfnStack object from getResource() for a nested stack that was not in the includeNestedStacks property', () => {
     const cfnTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-two-children.json'),
     });
@@ -370,10 +370,10 @@ describe('CDK Include for nested stacks', () => {
     expect(childStack1).toBeInstanceOf(core.CfnStack);
   });
 
-  test('returns the CfnStack object from getResource() for a nested stack that was in the nestedStacks property', () => {
+  test('returns the CfnStack object from getResource() for a nested stack that was in the includeNestedStacks property', () => {
     const cfnTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-one-child.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('child-import-stack.json'),
         },
@@ -388,7 +388,7 @@ describe('CDK Include for nested stacks', () => {
   test("handles Metadata, DeletionPolicy, and UpdateReplacePolicy attributes of the nested stack's resource", () => {
     const cfnTemplate = new inc.CfnInclude(stack, 'ParentStack', {
       templateFile: testTemplateFilePath('parent-with-attributes.json'),
-      nestedStacks: {
+      includeNestedStacks: {
         'ChildStack': {
           templateFile: testTemplateFilePath('child-import-stack.json'),
         },
@@ -456,10 +456,10 @@ describe('CDK Include for nested stacks', () => {
       assetStack = new core.Stack();
       parentTemplate = new inc.CfnInclude(assetStack, 'ParentStack', {
         templateFile: testTemplateFilePath('parent-one-child.json'),
-        nestedStacks: {
+        includeNestedStacks: {
           'ChildStack': {
             templateFile: testTemplateFilePath('child-no-bucket.json'),
-            nestedStacks: {
+            includeNestedStacks: {
               'GrandChildStack': {
                 templateFile: testTemplateFilePath('grandchild-import-stack.json'),
               },
@@ -635,7 +635,7 @@ describe('CDK Include for nested stacks', () => {
       parentStack = new core.Stack();
       const parentTemplate = new inc.CfnInclude(parentStack, 'ParentStack', {
         templateFile: testTemplateFilePath('parent-two-parameters.json'),
-        nestedStacks: {
+        includeNestedStacks: {
           'ChildStack': {
             templateFile: testTemplateFilePath('child-two-parameters.json'),
             parameters: {