fix(apigatewayv2): ApiMapping does not depend on DomainName (#16201)

When an ApiMapping resource is deployed using the Domain defined in the DomainName resource, the DomainName resource must be deployed before the ApiMapping resource. Since the current logic uses the CloudFormation Output of DomainName as a fall back, preferring the user provided string first, this dependency is not expressed in the resulting template. Remove the preference for the user provided string, will inform synthesis that the dependency must be declared. fixes #15464 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
aws · Sep 9, 2021 · 1e247d8 · 1e247d8
1 parent 87f62b7
commit 1e247d8
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/packages/@aws-cdk/aws-apigatewayv2/lib/common/domain-name.ts b/packages/@aws-cdk/aws-apigatewayv2/lib/common/domain-name.ts
@@ -98,7 +98,7 @@ export class DomainName extends Resource implements IDomainName {
       ],
     };
     const resource = new CfnDomainName(this, 'Resource', domainNameProps);
-    this.name = props.domainName ?? resource.ref;
+    this.name = resource.ref;
     this.regionalDomainName = Token.asString(resource.getAtt('RegionalDomainName'));
     this.regionalHostedZoneId = Token.asString(resource.getAtt('RegionalHostedZoneId'));
   }

diff --git a/packages/@aws-cdk/aws-apigatewayv2/test/common/api-mapping.test.ts b/packages/@aws-cdk/aws-apigatewayv2/test/common/api-mapping.test.ts
@@ -26,7 +26,6 @@ describe('ApiMapping', () => {
       ApiId: {
         Ref: 'ApiF70053CD',
       },
-      DomainName: 'example.com',
       Stage: '$default',
     });
   });
@@ -58,7 +57,6 @@ describe('ApiMapping', () => {
       ApiId: {
         Ref: 'ApiF70053CD',
       },
-      DomainName: 'example.com',
       Stage: 'beta',
       ApiMappingKey: 'beta',
     });

diff --git a/packages/@aws-cdk/aws-apigatewayv2/test/http/domain-name.test.ts b/packages/@aws-cdk/aws-apigatewayv2/test/http/domain-name.test.ts
@@ -102,7 +102,9 @@ describe('DomainName', () => {
       ApiId: {
         Ref: 'ApiF70053CD',
       },
-      DomainName: 'example.com',
+      DomainName: {
+        Ref: 'DNFDC76583',
+      },
       Stage: 'beta',
       ApiMappingKey: 'beta',
     });
@@ -139,7 +141,9 @@ describe('DomainName', () => {
       ApiId: {
         Ref: 'ApiF70053CD',
       },
-      DomainName: 'example.com',
+      DomainName: {
+        Ref: 'DNFDC76583',
+      },
       Stage: '$default',
     });
   });

diff --git a/packages/@aws-cdk/aws-apigatewayv2/test/http/stage.test.ts b/packages/@aws-cdk/aws-apigatewayv2/test/http/stage.test.ts
@@ -140,7 +140,11 @@ describe('HttpStage with domain mapping', () => {
       },
     });
 
-    expect(stage.domainUrl).toBe(`https://${domainName}/`);
+    expect(stack.resolve(stage.domainUrl)).toEqual({
+      'Fn::Join': ['', [
+        'https://', { Ref: 'DNFDC76583' }, '/',
+      ]],
+    });
   });
 
   test('domainUrl throws error if domainMapping is not configured', () => {