feat(cloudfront-origins): allow custom originPath for apigateway.Rest…

…Api constructs
aws · Feb 10, 2023 · 1b5eedc · 1b5eedc
1 parent 0570e01
commit 1b5eedc
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/packages/@aws-cdk/aws-cloudfront-origins/lib/rest-api-origin.ts b/packages/@aws-cdk/aws-cloudfront-origins/lib/rest-api-origin.ts
@@ -6,7 +6,7 @@ import { validateSecondsInRangeOrUndefined } from './private/utils';
 /**
  * Properties for an Origin for an API Gateway REST API.
  */
-export interface RestApiOriginProps extends cloudfront.OriginOptions {
+export interface RestApiOriginProps extends cloudfront.OriginProps {
   /**
    * Specifies how long, in seconds, CloudFront waits for a response from the origin, also known as the origin response timeout.
    * The valid range is from 1 to 180 seconds, inclusive.
@@ -40,7 +40,7 @@ export class RestApiOrigin extends cloudfront.OriginBase {
     // Splitting on '/' gives: ['https', '', '<rest-api-id>.execute-api.<region>.amazonaws.com', '<stage>']
     // The element at index 2 is the domain name, the element at index 3 is the stage name
     super(cdk.Fn.select(2, cdk.Fn.split('/', restApi.url)), {
-      originPath: `/${cdk.Fn.select(3, cdk.Fn.split('/', restApi.url))}`,
+      originPath: props.originPath ?? `/${cdk.Fn.select(3, cdk.Fn.split('/', restApi.url))}`,
       ...props,
     });
 

diff --git a/packages/@aws-cdk/aws-cloudfront-origins/test/rest-api-origin.test.ts b/packages/@aws-cdk/aws-cloudfront-origins/test/rest-api-origin.test.ts
@@ -113,3 +113,38 @@ test('Correctly renders the origin, with custom originId', () => {
     },
   });
 });
+
+test('Correctly renders the origin, with custom originPath', () => {
+  const api = new apigateway.RestApi(stack, 'RestApi');
+  api.root.addMethod('GET');
+
+  const origin = new RestApiOrigin(api, { originPath: '/my/custom/path' });
+  const originBindConfig = origin.bind(stack, { originId: 'StackOrigin029E19582' });
+
+  expect(stack.resolve(originBindConfig.originProperty)).toEqual({
+    id: 'StackOrigin029E19582',
+    domainName: {
+      'Fn::Select': [2, {
+        'Fn::Split': ['/', {
+          'Fn::Join': ['', [
+            'https://', { Ref: 'RestApi0C43BF4B' },
+            '.execute-api.',
+            { Ref: 'AWS::Region' },
+            '.',
+            { Ref: 'AWS::URLSuffix' },
+            '/',
+            { Ref: 'RestApiDeploymentStageprod3855DE66' },
+            '/',
+          ]],
+        }],
+      }],
+    },
+    originPath: '/my/custom/path',
+    customOriginConfig: {
+      originProtocolPolicy: 'https-only',
+      originSslProtocols: [
+        'TLSv1.2',
+      ],
+    },
+  });
+});