feat(apigateway): configure endpoint types on SpecRestApi

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

@@ -986,11 +986,29 @@ to configure these.
 There are a number of limitations in using OpenAPI definitions in API Gateway. Read the [Amazon API Gateway important
 notes for REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html#api-gateway-known-issues-rest-apis)
 for more details.
-
+ 
 **Note:** When starting off with an OpenAPI definition using `SpecRestApi`, it is not possible to configure some
 properties that can be configured directly in the OpenAPI specification file. This is to prevent people duplication
 of these properties and potential confusion.
 
+### Endpoint configuration
+
+By default, SpecRestApi will create an endpoint with a edge optimized endpoint configuration.
+
+It is possible to modify this by providing the endpointConfiguration as shown here:
+
+```ts
+const api = new apigateway.SpecRestApi(this, 'ExampleRestApi', {
+  apiDefinition: apigateway.ApiDefinition.fromInline(replacedSwagger),
+  endpointConfiguration: {
+    types: [apigateway.EndpointType.PRIVATE],
+  },
+});
+```
+
+**Note:** For private endpoints you will still need to provide the `x-amazon-apigateway-policy` in your openApi file.
+
+
 ## APIGateway v2
 
 APIGateway v2 APIs are now moved to its own package named `aws-apigatewayv2`. For backwards compatibility, existing

packages/@aws-cdk/aws-apigateway/lib/restapi.ts

@@ -159,6 +159,14 @@ export interface RestApiOptions extends ResourceOptions {
    * @default - when no export name is given, output will be created without export
    */
   readonly endpointExportName?: string;
+
+  /**
+   * The EndpointConfiguration property type specifies the endpoint types of a REST API
+   * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
+   *
+   * @default - No endpoint configuration
+   */
+  readonly endpointConfiguration?: EndpointConfiguration;
 }
 
 /**
@@ -207,20 +215,12 @@ export interface RestApiProps extends RestApiOptions {
    */
   readonly apiKeySourceType?: ApiKeySourceType;
 
-  /**
-   * The EndpointConfiguration property type specifies the endpoint types of a REST API
-   * @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
-   *
-   * @default - No endpoint configuration
-   */
-  readonly endpointConfiguration?: EndpointConfiguration;
-
   /**
    * A list of the endpoint types of the API. Use this property when creating
    * an API.
    *
    * @default - No endpoint types.
-   * @deprecated this property is deprecated, use endpointConfiguration instead
+   * @deprecated this property is deprecated, use endpointConfiguration in the RestApiOptions instead
    */
   readonly endpointTypes?: EndpointType[];
 }
@@ -416,6 +416,22 @@ export abstract class RestApiBase extends Resource implements IRestApi {
       }
     }
   }
+
+  protected configureEndpoints(props: RestApiProps): CfnRestApi.EndpointConfigurationProperty | undefined {
+    if (props.endpointTypes && props.endpointConfiguration) {
+      throw new Error('Only one of the RestApi props, endpointTypes or endpointConfiguration, is allowed');
+    }
+    if (props.endpointConfiguration) {
+      return {
+        types: props.endpointConfiguration.types,
+        vpcEndpointIds: props.endpointConfiguration?.vpcEndpoints?.map(vpcEndpoint => vpcEndpoint.vpcEndpointId),
+      };
+    }
+    if (props.endpointTypes) {
+      return { types: props.endpointTypes };
+    }
+    return undefined;
+  }
 }
 
 /**
@@ -456,6 +472,7 @@ export class SpecRestApi extends RestApiBase {
       failOnWarnings: props.failOnWarnings,
       body: apiDefConfig.inlineDefinition ? apiDefConfig.inlineDefinition : undefined,
       bodyS3Location: apiDefConfig.inlineDefinition ? undefined : apiDefConfig.s3Location,
+      endpointConfiguration: this.configureEndpoints(props),
       parameters: props.parameters,
     });
     this.node.defaultChild = resource;
@@ -632,22 +649,6 @@ export class RestApi extends RestApiBase {
 
     return [];
   }
-
-  private configureEndpoints(props: RestApiProps): CfnRestApi.EndpointConfigurationProperty | undefined {
-    if (props.endpointTypes && props.endpointConfiguration) {
-      throw new Error('Only one of the RestApi props, endpointTypes or endpointConfiguration, is allowed');
-    }
-    if (props.endpointConfiguration) {
-      return {
-        types: props.endpointConfiguration.types,
-        vpcEndpointIds: props.endpointConfiguration?.vpcEndpoints?.map(vpcEndpoint => vpcEndpoint.vpcEndpointId),
-      };
-    }
-    if (props.endpointTypes) {
-      return { types: props.endpointTypes };
-    }
-    return undefined;
-  }
 }
 
 /**

packages/@aws-cdk/aws-apigateway/test/integ.api-definition.inline.private.expected.json

@@ -0,0 +1,182 @@
+{
+  "Resources": {
+    "myprivateapiD2D027EE": {
+      "Type": "AWS::ApiGateway::RestApi",
+      "Properties": {
+        "Body": {
+          "openapi": "3.0.2",
+          "info": {
+            "version": "1.0.0",
+            "title": "Test API for CDK"
+          },
+          "paths": {
+            "/pets": {
+              "get": {
+                "summary": "Test Method",
+                "operationId": "testMethod",
+                "responses": {
+                  "200": {
+                    "description": "A paged array of pets",
+                    "content": {
+                      "application/json": {
+                        "schema": {
+                          "$ref": "#/components/schemas/Empty"
+                        }
+                      }
+                    }
+                  }
+                },
+                "x-amazon-apigateway-integration": {
+                  "responses": {
+                    "default": {
+                      "statusCode": "200"
+                    }
+                  },
+                  "requestTemplates": {
+                    "application/json": "{\"statusCode\": 200}"
+                  },
+                  "passthroughBehavior": "when_no_match",
+                  "type": "mock"
+                }
+              }
+            }
+          },
+          "components": {
+            "schemas": {
+              "Empty": {
+                "title": "Empty Schema",
+                "type": "object"
+              }
+            }
+          }
+        },
+        "EndpointConfiguration": {
+          "Types": [
+            "PRIVATE"
+          ]
+        },
+        "Name": "my-private-api"
+      }
+    },
+    "myprivateapiDeployment16B560CC678219fa18beb0906b49cad02ed224e8": {
+      "Type": "AWS::ApiGateway::Deployment",
+      "Properties": {
+        "RestApiId": {
+          "Ref": "myprivateapiD2D027EE"
+        },
+        "Description": "Automatically created by the RestApi construct"
+      }
+    },
+    "myprivateapiDeploymentStageprodC271AE68": {
+      "Type": "AWS::ApiGateway::Stage",
+      "Properties": {
+        "RestApiId": {
+          "Ref": "myprivateapiD2D027EE"
+        },
+        "DeploymentId": {
+          "Ref": "myprivateapiDeployment16B560CC678219fa18beb0906b49cad02ed224e8"
+        },
+        "StageName": "prod"
+      }
+    },
+    "myprivateapiCloudWatchRole82F3E469": {
+      "Type": "AWS::IAM::Role",
+      "Properties": {
+        "AssumeRolePolicyDocument": {
+          "Statement": [
+            {
+              "Action": "sts:AssumeRole",
+              "Effect": "Allow",
+              "Principal": {
+                "Service": "apigateway.amazonaws.com"
+              }
+            }
+          ],
+          "Version": "2012-10-17"
+        },
+        "ManagedPolicyArns": [
+          {
+            "Fn::Join": [
+              "",
+              [
+                "arn:",
+                {
+                  "Ref": "AWS::Partition"
+                },
+                ":iam::aws:policy/service-role/AmazonAPIGatewayPushToCloudWatchLogs"
+              ]
+            ]
+          }
+        ]
+      }
+    },
+    "myprivateapiAccount8564096B": {
+      "Type": "AWS::ApiGateway::Account",
+      "Properties": {
+        "CloudWatchRoleArn": {
+          "Fn::GetAtt": [
+            "myprivateapiCloudWatchRole82F3E469",
+            "Arn"
+          ]
+        }
+      },
+      "DependsOn": [
+        "myprivateapiD2D027EE"
+      ]
+    }
+  },
+  "Outputs": {
+    "myprivateapiEndpoint40EE1421": {
+      "Value": {
+        "Fn::Join": [
+          "",
+          [
+            "https://",
+            {
+              "Ref": "myprivateapiD2D027EE"
+            },
+            ".execute-api.",
+            {
+              "Ref": "AWS::Region"
+            },
+            ".",
+            {
+              "Ref": "AWS::URLSuffix"
+            },
+            "/",
+            {
+              "Ref": "myprivateapiDeploymentStageprodC271AE68"
+            },
+            "/"
+          ]
+        ]
+      }
+    },
+    "PetsURL": {
+      "Value": {
+        "Fn::Join": [
+          "",
+          [
+            "https://",
+            {
+              "Ref": "myprivateapiD2D027EE"
+            },
+            ".execute-api.",
+            {
+              "Ref": "AWS::Region"
+            },
+            ".",
+            {
+              "Ref": "AWS::URLSuffix"
+            },
+            "/",
+            {
+              "Ref": "myprivateapiDeploymentStageprodC271AE68"
+            },
+            "/pets"
+          ]
+        ]
+      }
+    }
+  }
+}

packages/@aws-cdk/aws-apigateway/test/integ.api-definition.inline.private.ts

@@ -0,0 +1,69 @@
+import * as cdk from '@aws-cdk/core';
+import * as apigateway from '../lib';
+
+/*
+ * Stack verification steps:
+ * * `curl -i <CFN output PetsURL>` should return HTTP code 200
+ */
+
+const app = new cdk.App();
+const stack = new cdk.Stack(app, 'integtest-restapi-fromdefinition-inline-private');
+
+const api = new apigateway.SpecRestApi(stack, 'my-private-api', {
+  apiDefinition: apigateway.ApiDefinition.fromInline({
+    openapi: '3.0.2',
+    info: {
+      version: '1.0.0',
+      title: 'Test API for CDK',
+    },
+    paths: {
+      '/pets': {
+        get: {
+          'summary': 'Test Method',
+          'operationId': 'testMethod',
+          'responses': {
+            200: {
+              description: 'A paged array of pets',
+              content: {
+                'application/json': {
+                  schema: {
+                    $ref: '#/components/schemas/Empty',
+                  },
+                },
+              },
+            },
+          },
+          'x-amazon-apigateway-integration': {
+            responses: {
+              default: {
+                statusCode: '200',
+              },
+            },
+            requestTemplates: {
+              'application/json': '{"statusCode": 200}',
+            },
+            passthroughBehavior: 'when_no_match',
+            type: 'mock',
+          },
+        },
+      },
+    },
+    components: {
+      schemas: {
+        Empty: {
+          title: 'Empty Schema',
+          type: 'object',
+        },
+      },
+    },
+  }),
+  endpointConfiguration: {
+    types: [apigateway.EndpointType.PRIVATE],
+  },
+});
+
+new cdk.CfnOutput(stack, 'PetsURL', {
+  value: api.urlForPath('/pets'),
+});
+
+app.synth();