Merge pull request #524 from raphaeldeem-acorns/rd/add-endpoint-configuration

add vpcEndpointIds to EndpointConfiguration

Author: lopburny

lib/deploy/events/apiGateway/restApi.js

@@ -13,6 +13,7 @@ module.exports = {
     this.apiGatewayRestApiLogicalId = this.provider.naming.getRestApiLogicalId();
 
     let endpointType = 'EDGE';
+    let vpcEndpointIds;
 
     if (this.serverless.service.provider.endpointType) {
       const validEndpointTypes = ['REGIONAL', 'EDGE', 'PRIVATE'];
@@ -22,6 +23,16 @@ module.exports = {
         throw new this.serverless.classes.Error('endpointType must be a string');
       }
 
+      if (this.serverless.service.provider.vpcEndpointIds) {
+        vpcEndpointIds = this.serverless.service.provider.vpcEndpointIds;
+
+        if (endpointType !== 'PRIVATE') {
+          throw new Error(
+            'VPC endpoint IDs are only available for private APIs',
+            'API_GATEWAY_INVALID_VPC_ENDPOINT_IDS_CONFIG',
+          );
+        }
+      }
 
       if (!_.includes(validEndpointTypes, endpointType.toUpperCase())) {
         const message = 'endpointType must be one of "REGIONAL" or "EDGE" or "PRIVATE". '
@@ -31,14 +42,20 @@ module.exports = {
       endpointType = endpointType.toUpperCase();
     }
 
+    const EndpointConfiguration = {
+      Types: [endpointType],
+    };
+
+    if (vpcEndpointIds) {
+      EndpointConfiguration.VpcEndpointIds = vpcEndpointIds;
+    }
+
     _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Resources, {
       [this.apiGatewayRestApiLogicalId]: {
         Type: 'AWS::ApiGateway::RestApi',
         Properties: {
           Name: this.provider.naming.getApiGatewayName(),
-          EndpointConfiguration: {
-            Types: [endpointType],
-          },
+          EndpointConfiguration,
         },
       },
     });

lib/deploy/events/apiGateway/restApi.test.js

@@ -9,6 +9,23 @@ describe('#compileRestApi()', () => {
   let serverless;
   let serverlessStepFunctions;
 
+  const serviceResourcesAwsResourcesPrivateObjectMock = {
+    Resources: {
+      ApiGatewayRestApi: {
+        Type: 'AWS::ApiGateway::RestApi',
+        Properties: {
+          Name: 'dev-new-service',
+          EndpointConfiguration: {
+            Types: ['PRIVATE'],
+            VpcEndpointIds: [
+              'vpc-11abcdefgh',
+            ],
+          },
+        },
+      },
+    },
+  };
+
   const serviceResourcesAwsResourcesObjectMock = {
     Resources: {
       ApiGatewayRestApi: {
@@ -125,6 +142,23 @@ describe('#compileRestApi()', () => {
     });
   });
 
+  it('throw error if vpcEndpointIds and endpointType is not PRIVATE', () => {
+    serverlessStepFunctions.serverless.service.provider.vpcEndpointIds = ['vpc-11abcdefgh'];
+    serverlessStepFunctions.serverless.service.provider.endpointType = 'EDGE';
+    expect(() => serverlessStepFunctions.compileRestApi()).to.throw(Error);
+  });
+
+  it('should create a Private REST API Resource with VPC Endpoints', () => {
+    serverlessStepFunctions.serverless.service.provider.vpcEndpointIds = ['vpc-11abcdefgh'];
+    serverlessStepFunctions.serverless.service.provider.endpointType = 'PRIVATE';
+    return serverlessStepFunctions.compileRestApi().then(() => {
+      expect(serverlessStepFunctions.serverless.service
+        .provider.compiledCloudFormationTemplate.Resources).to.deep.equal(
+        serviceResourcesAwsResourcesPrivateObjectMock.Resources,
+      );
+    });
+  });
+
   it('throw error if endpointType property is not a string', () => {
     serverlessStepFunctions.serverless.service.provider.endpointType = ['EDGE'];
     expect(() => serverlessStepFunctions.compileRestApi()).to.throw(Error);