fix(asg/ec2): fix value of defaultChild

`AutoScalingGroup` and `Subnet` had default children with incorrect names, so that `defaultChild` would not pick them up. Add and use an override mechanism so that people can use the escape hatch more conveniently with those constructs. Fixes #3478.
aws · Aug 7, 2019 · 226a659 · 226a659
1 parent 4e11d86
commit 226a659
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 2 deletions.
diff --git a/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts b/packages/@aws-cdk/aws-autoscaling/lib/auto-scaling-group.ts
@@ -459,6 +459,7 @@ export class AutoScalingGroup extends AutoScalingGroupBase implements
       resource: 'autoScalingGroup:*:autoScalingGroupName',
       resourceName: this.autoScalingGroupName
     });
+    this.node.defaultChild = this.autoScalingGroup;
 
     this.applyUpdatePolicies(props);
   }

diff --git a/packages/@aws-cdk/aws-autoscaling/test/test.auto-scaling-group.ts b/packages/@aws-cdk/aws-autoscaling/test/test.auto-scaling-group.ts
@@ -605,7 +605,23 @@ export = {
       "Roles": ["HelloDude"]
     }));
     test.done();
-  }
+  },
+
+  'defaultChild is available on an ASG'(test: Test) {
+    // GIVEN
+    const stack = new cdk.Stack();
+    const vpc = mockVpc(stack);
+    const asg = new autoscaling.AutoScalingGroup(stack, 'MyStack', {
+      instanceType: ec2.InstanceType.of(ec2.InstanceClass.M4, ec2.InstanceSize.MICRO),
+      machineImage: new ec2.AmazonLinuxImage(),
+      vpc,
+    });
+
+    // THEN
+    test.notEqual(asg.node.defaultChild, undefined);
+
+    test.done();
+  },
 };
 
 function mockVpc(stack: cdk.Stack) {

diff --git a/packages/@aws-cdk/aws-ec2/lib/vpc.ts b/packages/@aws-cdk/aws-ec2/lib/vpc.ts
@@ -1165,6 +1165,7 @@ export class Subnet extends Resource implements ISubnet {
     this.subnetAvailabilityZone = subnet.attrAvailabilityZone;
     this.subnetIpv6CidrBlocks = subnet.attrIpv6CidrBlocks;
     this.subnetNetworkAclAssociationId = subnet.attrNetworkAclAssociationId;
+    this.node.defaultChild = subnet;
 
     const table = new CfnRouteTable(this, 'RouteTable', {
       vpcId: props.vpcId,

diff --git a/packages/@aws-cdk/aws-ec2/test/test.vpc.ts b/packages/@aws-cdk/aws-ec2/test/test.vpc.ts
@@ -540,8 +540,18 @@ export = {
       }), /`vpnGatewayAsn`.+`vpnGateway`.+false/);
 
       test.done();
-    }
+    },
+
+    'Subnets have a defaultChild'(test: Test) {
+      // GIVEN
+      const stack = new Stack();
 
+      const vpc = new Vpc(stack, 'VpcNetwork');
+
+      test.notEqual(vpc.publicSubnets[0].node.defaultChild, undefined);
+
+      test.done();
+    },
   },
 
   "When creating a VPC with a custom CIDR range": {

diff --git a/packages/@aws-cdk/core/lib/construct.ts b/packages/@aws-cdk/core/lib/construct.ts
@@ -125,6 +125,7 @@ export class ConstructNode {
   private readonly _references = new Set<Reference>();
   private readonly _dependencies = new Set<IDependable>();
   private readonly invokedAspects: IAspect[] = [];
+  private _defaultChild: IConstruct | undefined;
 
   constructor(private readonly host: Construct, scope: IConstruct, id: string) {
     id = id || ''; // if undefined, convert to empty string
@@ -202,6 +203,10 @@ export class ConstructNode {
    * @returns a construct or undefined if there is no default child
    */
   public get defaultChild(): IConstruct | undefined {
+    if (this._defaultChild !== undefined) {
+      return this._defaultChild;
+    }
+
     const resourceChild = this.tryFindChild('Resource');
     const defaultChild = this.tryFindChild('Default');
     if (resourceChild && defaultChild) {
@@ -211,6 +216,17 @@ export class ConstructNode {
     return defaultChild || resourceChild;
   }
 
+  /**
+   * Override the defaultChild property.
+   *
+   * This should only be used in the cases where the correct
+   * default child is not named 'Resource' or 'Default' as it
+   * should be.
+   */
+  public set defaultChild(value: IConstruct | undefined) {
+    this._defaultChild = value;
+  }
+
   /**
    * All direct children of this construct.
    */