chore(apigatewayv2): move lambda and http proxy integrations to the '…

…integrations' module (#11339)

We now have a `@aws-cdk/aws-apigatewayv2-integrations` module that is
intended to hold all integration of HTTP APIs with other services.

In line with this, move `LambdaProxyIntegration` and
`HttpProxyIntegration` classes to this module.

BREAKING CHANGE: `LambdaProxyIntegration` and `HttpProxyIntegration`
classes have moved to the `@aws-cdk/aws-apigatewayv2-integration` module.


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

packages/@aws-cdk/aws-apigatewayv2-integrations/README.md

@@ -11,24 +11,74 @@
 
 ## Table of Contents
 
-- [Introduction](#introduction)
-- [Private Integration](#private-integration)
+- [HTTP APIs](#http-apis)
+  - [Lambda Integration](#lambda)
+  - [HTTP Proxy Integration](#http-proxy)
+  - [Private Integration](#private-integration)
 
-## Introduction
+## HTTP APIs
 
 Integrations connect a route to backend resources. HTTP APIs support Lambda proxy, AWS service, and HTTP proxy integrations. HTTP proxy integrations are also known as private integrations.
 
-Currently the following integrations are supported by this construct library.
+### Lambda
 
-## Private Integration
+Lambda integrations enable integrating an HTTP API route with a Lambda function. When a client invokes the route, the
+API Gateway service forwards the request to the Lambda function and returns the function's response to the client.
+
+The API Gateway service will invoke the lambda function with an event payload of a specific format. The service expects
+the function to respond in a specific format. The details on this format is available at [Working with AWS Lambda
+proxy integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html).
+
+The following code configures a route `GET /books` with a Lambda proxy integration.
+
+```ts
+const booksFn = new lambda.Function(stack, 'BooksDefaultFn', { ... });
+const booksIntegration = new LambdaProxyIntegration({
+  handler: booksDefaultFn,
+});
+
+const httpApi = new HttpApi(stack, 'HttpApi');
+
+httpApi.addRoutes({
+  path: '/books',
+  methods: [ HttpMethod.GET ],
+  integration: booksIntegration,
+});
+```
+
+### HTTP Proxy
+
+HTTP Proxy integrations enables connecting an HTTP API route to a publicly routable HTTP endpoint. When a client
+invokes the route, the API Gateway service forwards the entire request and response between the API Gateway endpoint
+and the integrating HTTP endpoint. More information can be found at [Working with HTTP proxy
+integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-http.html).
+
+The following code configures a route `GET /books` with an HTTP proxy integration to an HTTP endpoint
+`get-books-proxy.myproxy.internal`.
+
+```ts
+const booksIntegration = new HttpProxyIntegration({
+  url: 'https://get-books-proxy.myproxy.internal',
+});
+
+const httpApi = new HttpApi(stack, 'HttpApi');
+
+httpApi.addRoutes({
+  path: '/books',
+  methods: [ HttpMethod.GET ],
+  integration: booksIntegration,
+});
+```
+
+### Private Integration
 
 Private integrations enable integrating an HTTP API route with private resources in a VPC, such as Application Load Balancers or
 Amazon ECS container-based applications.  Using private integrations, resources in a VPC can be exposed for access by
 clients outside of the VPC.
 
 The following integrations are supported for private resources in a VPC.
 
-### Application Load Balancer
+#### Application Load Balancer
 
 The following code is a basic application load balancer private integration of HTTP API:
 
@@ -47,7 +97,7 @@ const httpEndpoint = new HttpApi(stack, 'HttpProxyPrivateApi', {
 });
 ```
 
-### Network Load Balancer
+#### Network Load Balancer
 
 The following code is a basic network load balancer private integration of HTTP API:
 
@@ -66,7 +116,7 @@ const httpEndpoint = new HttpApi(stack, 'HttpProxyPrivateApi', {
 });
 ```
 
-### Cloud Map Service Discovery
+#### Cloud Map Service Discovery
 
 The following code is a basic discovery service private integration of HTTP API:
 

packages/@aws-cdk/aws-apigatewayv2/lib/http/integrations/http.ts → packages/@aws-cdk/aws-apigatewayv2-integrations/lib/http/http-proxy.ts

@@ -1,5 +1,11 @@
-import { HttpIntegrationType, HttpRouteIntegrationBindOptions, HttpRouteIntegrationConfig, IHttpRouteIntegration, PayloadFormatVersion } from '../integration';
-import { HttpMethod } from '../route';
+import {
+  HttpIntegrationType,
+  HttpRouteIntegrationBindOptions,
+  HttpRouteIntegrationConfig,
+  HttpMethod,
+  IHttpRouteIntegration,
+  PayloadFormatVersion,
+} from '@aws-cdk/aws-apigatewayv2';
 
 /**
  * Properties to initialize a new `HttpProxyIntegration`.

packages/@aws-cdk/aws-apigatewayv2-integrations/lib/http/index.ts

@@ -2,3 +2,5 @@ export * from './base-types';
 export * from './alb';
 export * from './nlb';
 export * from './service-discovery';
+export * from './http-proxy';
+export * from './lambda';

packages/@aws-cdk/aws-apigatewayv2/lib/http/integrations/lambda.ts → packages/@aws-cdk/aws-apigatewayv2-integrations/lib/http/lambda.ts

@@ -1,7 +1,13 @@
+import {
+  HttpIntegrationType,
+  HttpRouteIntegrationBindOptions,
+  HttpRouteIntegrationConfig,
+  IHttpRouteIntegration,
+  PayloadFormatVersion,
+} from '@aws-cdk/aws-apigatewayv2';
 import { ServicePrincipal } from '@aws-cdk/aws-iam';
 import { IFunction } from '@aws-cdk/aws-lambda';
 import { Names, Stack } from '@aws-cdk/core';
-import { HttpIntegrationType, HttpRouteIntegrationBindOptions, HttpRouteIntegrationConfig, IHttpRouteIntegration, PayloadFormatVersion } from '../integration';
 
 /**
  * Lambda Proxy integration properties

packages/@aws-cdk/aws-apigatewayv2-integrations/package.json

@@ -81,6 +81,8 @@
     "@aws-cdk/aws-apigatewayv2": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",
     "@aws-cdk/aws-elasticloadbalancingv2": "0.0.0",
+    "@aws-cdk/aws-iam": "0.0.0",
+    "@aws-cdk/aws-lambda": "0.0.0",
     "@aws-cdk/aws-servicediscovery": "0.0.0",
     "@aws-cdk/core": "0.0.0",
     "constructs": "^3.2.0"
@@ -89,6 +91,8 @@
     "@aws-cdk/aws-apigatewayv2": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",
     "@aws-cdk/aws-elasticloadbalancingv2": "0.0.0",
+    "@aws-cdk/aws-iam": "0.0.0",
+    "@aws-cdk/aws-lambda": "0.0.0",
     "@aws-cdk/aws-servicediscovery": "0.0.0",
     "@aws-cdk/core": "0.0.0",
     "constructs": "^3.2.0"

packages/@aws-cdk/aws-apigatewayv2/test/http/integrations/http.test.ts → packages/@aws-cdk/aws-apigatewayv2-integrations/test/http/http-proxy.test.ts

@@ -1,6 +1,7 @@
 import '@aws-cdk/assert/jest';
+import { HttpApi, HttpIntegration, HttpIntegrationType, HttpMethod, HttpRoute, HttpRouteKey, PayloadFormatVersion } from '@aws-cdk/aws-apigatewayv2';
 import { Stack } from '@aws-cdk/core';
-import { HttpApi, HttpIntegration, HttpIntegrationType, HttpMethod, HttpProxyIntegration, HttpRoute, HttpRouteKey, PayloadFormatVersion } from '../../../lib';
+import { HttpProxyIntegration } from '../../lib';
 
 describe('HttpProxyIntegration', () => {
   test('default', () => {

packages/@aws-cdk/aws-apigatewayv2/test/http/integrations/integ.http-proxy.ts → packages/@aws-cdk/aws-apigatewayv2-integrations/test/http/integ.http-proxy.ts

@@ -1,6 +1,7 @@
+import { HttpApi } from '@aws-cdk/aws-apigatewayv2';
 import * as lambda from '@aws-cdk/aws-lambda';
 import { App, CfnOutput, Stack } from '@aws-cdk/core';
-import { HttpApi, HttpProxyIntegration, LambdaProxyIntegration } from '../../../lib';
+import { HttpProxyIntegration, LambdaProxyIntegration } from '../../lib';
 
 /*
  * Stack verification steps:

packages/@aws-cdk/aws-apigatewayv2/test/http/integrations/integ.lambda-proxy.ts → packages/@aws-cdk/aws-apigatewayv2-integrations/test/http/integ.lambda-proxy.ts

@@ -1,6 +1,7 @@
+import { HttpApi } from '@aws-cdk/aws-apigatewayv2';
 import * as lambda from '@aws-cdk/aws-lambda';
 import { App, CfnOutput, Stack } from '@aws-cdk/core';
-import { HttpApi, LambdaProxyIntegration } from '../../../lib';
+import { LambdaProxyIntegration } from '../../lib';
 
 /*
  * Stack verification steps:

packages/@aws-cdk/aws-apigatewayv2/test/http/integrations/lambda.test.ts → packages/@aws-cdk/aws-apigatewayv2-integrations/test/http/lambda.test.ts

@@ -1,7 +1,8 @@
 import '@aws-cdk/assert/jest';
+import { HttpApi, HttpRoute, HttpRouteKey, PayloadFormatVersion } from '@aws-cdk/aws-apigatewayv2';
 import { Code, Function, Runtime } from '@aws-cdk/aws-lambda';
 import { App, Stack } from '@aws-cdk/core';
-import { HttpApi, HttpRoute, HttpRouteKey, LambdaProxyIntegration, PayloadFormatVersion } from '../../../lib';
+import { LambdaProxyIntegration } from '../../lib';
 
 describe('LambdaProxyIntegration', () => {
   test('default', () => {

packages/@aws-cdk/aws-apigatewayv2/README.md

@@ -52,14 +52,13 @@ path, such as, `GET /books`. Learn more at [Working with
 routes](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html). Use the `ANY` method
 to match any methods for a route that are not explicitly defined.
 
-Integrations define how the HTTP API responds when a client reaches a specific Route. HTTP APIs support two types of
-integrations - Lambda proxy integration and HTTP proxy integration. Learn more at [Configuring
-integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html).
+Integrations define how the HTTP API responds when a client reaches a specific Route. HTTP APIs support Lambda proxy
+integration, HTTP proxy integration and, AWS service integrations, also known as private integrations. Learn more at
+[Configuring integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html).
 
-The code snippet below configures a route `GET /books` with an HTTP proxy integration and uses the `ANY` method to
-proxy all other HTTP method calls to `/books` to a lambda proxy.
-
-The URL to the endpoint can be retrieved via the `apiEndpoint` attribute.
+Integrations are available at the `aws-apigatewayv2-integrations` module and more information is available in that module.
+As an early example, the following code snippet configures a route `GET /books` with an HTTP proxy integration all
+configures all other HTTP method calls to `/books` to a lambda proxy.
 
 ```ts
 const getBooksIntegration = new HttpProxyIntegration({
@@ -85,6 +84,8 @@ httpApi.addRoutes({
 });
 ```
 
+The URL to the endpoint can be retrieved via the `apiEndpoint` attribute.
+
 The `defaultIntegration` option while defining HTTP APIs lets you create a default catch-all integration that is
 matched when a client reaches a route that is not explicitly defined.
 

packages/@aws-cdk/aws-apigatewayv2/lib/http/index.ts

@@ -1,7 +1,6 @@
 export * from './api';
 export * from './route';
 export * from './integration';
-export * from './integrations';
 export * from './stage';
 export * from './api-mapping';
 export * from './vpc-link';

packages/@aws-cdk/aws-apigatewayv2/package.json

@@ -83,15 +83,13 @@
     "@aws-cdk/aws-certificatemanager": "0.0.0",
     "@aws-cdk/aws-ec2": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
-    "@aws-cdk/aws-lambda": "0.0.0",
     "@aws-cdk/aws-cloudwatch": "0.0.0",
     "@aws-cdk/core": "0.0.0",
     "constructs": "^3.2.0"
   },
   "peerDependencies": {
     "@aws-cdk/aws-ec2": "0.0.0",
     "@aws-cdk/aws-iam": "0.0.0",
-    "@aws-cdk/aws-lambda": "0.0.0",
     "@aws-cdk/aws-certificatemanager": "0.0.0",
     "@aws-cdk/aws-cloudwatch": "0.0.0",
     "@aws-cdk/core": "0.0.0",

packages/@aws-cdk/aws-apigatewayv2/test/http/api.test.ts

@@ -2,9 +2,8 @@ import '@aws-cdk/assert/jest';
 import { ABSENT } from '@aws-cdk/assert';
 import { Metric } from '@aws-cdk/aws-cloudwatch';
 import * as ec2 from '@aws-cdk/aws-ec2';
-import { Code, Function, Runtime } from '@aws-cdk/aws-lambda';
 import { Duration, Stack } from '@aws-cdk/core';
-import { HttpApi, HttpMethod, LambdaProxyIntegration } from '../../lib';
+import { HttpApi, HttpIntegrationType, HttpMethod, HttpRouteIntegrationBindOptions, HttpRouteIntegrationConfig, IHttpRouteIntegration, PayloadFormatVersion } from '../../lib';
 
 describe('HttpApi', () => {
   test('default', () => {
@@ -50,13 +49,7 @@ describe('HttpApi', () => {
   test('default integration', () => {
     const stack = new Stack();
     const httpApi = new HttpApi(stack, 'api', {
-      defaultIntegration: new LambdaProxyIntegration({
-        handler: new Function(stack, 'fn', {
-          code: Code.fromInline('foo'),
-          runtime: Runtime.NODEJS_12_X,
-          handler: 'index.handler',
-        }),
-      }),
+      defaultIntegration: new DummyRouteIntegration(),
     });
 
     expect(stack).toHaveResourceLike('AWS::ApiGatewayV2::Route', {
@@ -76,13 +69,7 @@ describe('HttpApi', () => {
     httpApi.addRoutes({
       path: '/pets',
       methods: [HttpMethod.GET, HttpMethod.PATCH],
-      integration: new LambdaProxyIntegration({
-        handler: new Function(stack, 'fn', {
-          code: Code.fromInline('foo'),
-          runtime: Runtime.NODEJS_12_X,
-          handler: 'index.handler',
-        }),
-      }),
+      integration: new DummyRouteIntegration(),
     });
 
     expect(stack).toHaveResourceLike('AWS::ApiGatewayV2::Route', {
@@ -102,13 +89,7 @@ describe('HttpApi', () => {
 
     httpApi.addRoutes({
       path: '/pets',
-      integration: new LambdaProxyIntegration({
-        handler: new Function(stack, 'fn', {
-          code: Code.fromInline('foo'),
-          runtime: Runtime.NODEJS_12_X,
-          handler: 'index.handler',
-        }),
-      }),
+      integration: new DummyRouteIntegration(),
     });
 
     expect(stack).toHaveResourceLike('AWS::ApiGatewayV2::Route', {
@@ -281,3 +262,13 @@ describe('HttpApi', () => {
     expect(api.apiEndpoint).toBeDefined();
   });
 });
+
+class DummyRouteIntegration implements IHttpRouteIntegration {
+  public bind(_: HttpRouteIntegrationBindOptions): HttpRouteIntegrationConfig {
+    return {
+      payloadFormatVersion: PayloadFormatVersion.VERSION_2_0,
+      type: HttpIntegrationType.HTTP_PROXY,
+      uri: 'some-uri',
+    };
+  }
+}