feat(apigateway): configure endpoint types on SpecRestApi #9068

IsmaelMartinez · 2020-07-14T20:52:51Z

feat(apigateway): adding the ability to set the endpoint configuration for the OpenAPI 3.0

With this change, it will be possible to modify this by providing the endpointTypes as shown here:

const api = new apigateway.SpecRestApi(this, 'ExampleRestApi', {
  apiDefinition: apigateway.ApiDefinition.fromInline(replacedSwagger),
  endpointTypes: [apigateway.EndpointType.PRIVATE],
});

Note: For private endpoints you will still need to provide the x-amazon-apigateway-endpoint-configuration and x-amazon-apigateway-policy in your openApi file.

The following is an example with both settings:

{
    "openapi": "3.0.2",
    "servers" : [
      {
        "x-amazon-apigateway-endpoint-configuration": {
          "vpcEndpointIds": [
            "vpce-00111a1111a1aa011"
          ]
        }
      }
    ],
    "paths": { ... },
    "x-amazon-apigateway-policy": {
        "Version": "2012-10-17",
        "Statement": [
            {
                "Effect": "Allow",
                "Principal": "*",
                "Action": [
                    "execute-api:Invoke",
                    "execute-api:GET"
                ],
                "Resource": "arn:aws:execute-api:${AWS::Region}:${AWS::AccountId}:*",
                "Condition": {
                    "StringEquals": {
                      "aws:sourceVpce": "vpce-00111a1111a1aa011"
                    }
                }
            }
        ]
    }
}

Checklist for this PR:
🧪 Testing: adding integration testing for private API gateway.
📄 Docs: Add example in the README documentation about how to create a private API gateway with swagger

Fixes #9060

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

… for the SpecRestAPI

…to be set for an openApi 3.0 document

…check for private api

…example

…or-openapi3

IsmaelMartinez · 2020-07-15T11:01:26Z

I will check tomorrow or later tonight. I think is just that I reused the same name as another stack (a wee bit too much copy paste) in the integration test

…of github.com:IsmaelMartinez/aws-cdk into ismaelmartinez/add-endpointconfiguration-for-openapi3

…s different

…the logs

…or-openapi3

IsmaelMartinez · 2020-07-16T09:36:22Z

Hi @nija-at ,

The PR now is ready. I can probably add a better example to the README but wanted to get 1st the approach approved by you.

Basically, if you do the openAPI import like this.

    const api = new SpecRestApi(this, 'ExampleRestApi', {
      apiDefinition: ApiDefinition.fromInline(openAPIDocument),
      restApiName: `myTest`,
      deploy: false
    });

With something like this openAPI:

{
    "openapi": "3.0.1",
    "info": {
        "title": "ismael-test",
        "description": "ismael-test Rest API",
        "version": "1.0.1"
    },
    "servers" : [
        "x-amazon-apigateway-endpoint-configuration": {
            "vpcEndpointIds": [
                "vpce-00111a1111a1aa011"
            ]
        }
    ],
    "paths": {
        "/example": {
            "get": {
                "responses": {
                    "200": {
                        "description": "200 response",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/SampleResponse"
                                }
                            }
                        }
                    }
                },
                "x-amazon-apigateway-integration": {
                    "uri": "arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/arn:aws:lambda:${AWS::Region}:${AWS::AccountId}::function:ismael-test-st-imr:st-imr/invocations",
                    "responses": {
                        "default": {
                            "statusCode": "200"
                        }
                    },
                    "passthroughBehavior": "when_no_match",
                    "httpMethod": "POST",
                    "contentHandling": "CONVERT_TO_TEXT",
                    "type": "aws_proxy"
                }
            }
        }
    },
    "components": {
        "schemas": {
            "SampleResponse": {
                "title": "Sample Response",
                "type": "object",
                "properties": {
                    "message": {
                        "type": "string"
                    }
                }
            },
            "500Response": {
                "$ref": "#/components/schemas/Error"
            },
            "Error": {
                "type": "object",
                "properties": {
                    "errorCode": {
                        "type": "string"
                    },
                    "message": {
                        "type": "string"
                    }
                }
            }
        }
    },
    "x-amazon-apigateway-policy": {
        "Version": "2012-10-17",
        "Statement": [
            {
                "Effect": "Allow",
                "Principal": "*",
                "Action": [
                    "execute-api:Invoke",
                    "execute-api:GET"
                ],
                "Resource": "arn:aws:execute-api:${AWS::Region}:${AWS::AccountId}:*",
                "Condition": {
                    "StringEquals": {
                      "aws:sourceVpce": "vpce-00111a1111a1aa011"
                    }
                }
            }
        ]
    }
}

The deployment fails with the following message:

AmazonApiGateway; Status Code: 400; Error Code: BadRequestException;
Request ID: 12600381-6232-4213-894d-264b7501828b) ```

Do let me know if you prefer another approach for this.

Thanks in advance!

nija-at

Hey @IsmaelMartinez -

Thanks for submitting this PR!

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

nija-at · 2020-07-16T13:55:57Z

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

@@ -0,0 +1,69 @@
+import * as cdk from '@aws-cdk/core';


Instead of an integration test, add a unit test here instead.

I added a unit test. Waiting for the build to confirm it works... my machine (and GitPot) unit test keep failing in jest timeouts so using this slower approach.

Drop this integration test.

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

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

…of github.com:IsmaelMartinez/aws-cdk into ismaelmartinez/add-endpointconfiguration-for-openapi3

Pull request has been modified.

…or-openapi3

…of github.com:IsmaelMartinez/aws-cdk into ismaelmartinez/add-endpointconfiguration-for-openapi3

…or-openapi3

nija-at · 2020-08-03T10:47:06Z

@IsmaelMartinez - apologies, I was unavailable the last 2 weeks. I will take another look at this during this week.

You do not need to keep sync'ing with master. Once approved, our bot will do that once in the end before it is merged.

nija-at

Code looks mostly good.

Some comments around documentation below.

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

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

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

nija-at · 2020-08-04T09:40:43Z

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

@@ -0,0 +1,69 @@
+import * as cdk from '@aws-cdk/core';


Drop this integration test.

Pull request has been modified.

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

IsmaelMartinez · 2020-08-04T15:04:44Z

Code looks mostly good.

Some comments around documentation below.

comments addressed. If the build builds... we are good to go. Configuring a new laptop so took a bit longer than I wanted for this tiny changes. thanks for the review!

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

mergify · 2020-08-04T15:48:38Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

…or-openapi3

aws-cdk-automation · 2020-08-04T16:19:28Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
Commit ID: d165bba
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2020-08-04T16:19:55Z

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

jcrugzz · 2020-08-07T17:41:13Z

@nija-at is this included in a released version yet?

feat(apigateway): adding the ability to set the endpoint configuration for the OpenAPI 3.0 With this change, it will be possible to modify this by providing the endpointTypes as shown here: ``` const api = new apigateway.SpecRestApi(this, 'ExampleRestApi', { apiDefinition: apigateway.ApiDefinition.fromInline(replacedSwagger), endpointTypes: [apigateway.EndpointType.PRIVATE], }); ``` Note: For private endpoints you will still need to provide the `x-amazon-apigateway-endpoint-configuration` and `x-amazon-apigateway-policy` in your openApi file. The following is an example with both settings: ```json { "openapi": "3.0.2", "servers" : [ { "x-amazon-apigateway-endpoint-configuration": { "vpcEndpointIds": [ "vpce-00111a1111a1aa011" ] } } ], "paths": { ... }, "x-amazon-apigateway-policy": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": "*", "Action": [ "execute-api:Invoke", "execute-api:GET" ], "Resource": "arn:aws:execute-api:${AWS::Region}:${AWS::AccountId}:*", "Condition": { "StringEquals": { "aws:sourceVpce": "vpce-00111a1111a1aa011" } } } ] } } ``` Checklist for this PR: 🧪 Testing: adding integration testing for private API gateway. 📄 Docs: Add example in the README documentation about how to create a private API gateway with swagger Fixes #9060 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

feat(apigateway): adding the ability to set the endpoint configuration for the OpenAPI 3.0 With this change, it will be possible to modify this by providing the endpointTypes as shown here: ``` const api = new apigateway.SpecRestApi(this, 'ExampleRestApi', { apiDefinition: apigateway.ApiDefinition.fromInline(replacedSwagger), endpointTypes: [apigateway.EndpointType.PRIVATE], }); ``` Note: For private endpoints you will still need to provide the `x-amazon-apigateway-endpoint-configuration` and `x-amazon-apigateway-policy` in your openApi file. The following is an example with both settings: ```json { "openapi": "3.0.2", "servers" : [ { "x-amazon-apigateway-endpoint-configuration": { "vpcEndpointIds": [ "vpce-00111a1111a1aa011" ] } } ], "paths": { ... }, "x-amazon-apigateway-policy": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": "*", "Action": [ "execute-api:Invoke", "execute-api:GET" ], "Resource": "arn:aws:execute-api:${AWS::Region}:${AWS::AccountId}:*", "Condition": { "StringEquals": { "aws:sourceVpce": "vpce-00111a1111a1aa011" } } } ] } } ``` Checklist for this PR: 🧪 Testing: adding integration testing for private API gateway. 📄 Docs: Add example in the README documentation about how to create a private API gateway with swagger Fixes aws#9060 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

IsmaelMartinez · 2020-08-11T09:42:12Z

Looks like you can't, and should not, use the x-amazon-apigateway-endpoint-configuration to specify the vpce.

If you do, it complains that you can only specify the endpoint configuration for private API Gateway.

Using the policy x-amazon-apigateway-policy is enough.

I will create a documentation fix ticket in #9588.

IsmaelMartinez · 2020-08-14T08:09:54Z

Actually, closing that documentation ticket and creating a bug as there is an issue on 1st creation. Details in #9684

IsmaelMartinez and others added 6 commits July 14, 2020 16:43

feat(apigateway) adding the ability to set the endpoint configuration…

dd9f704

… for the SpecRestAPI

feat (apigateway): adding the ability for the endpoint configuration …

00c3ce4

…to be set for an openApi 3.0 document

pr adding initial integration test. WIP still need to add the actual …

8cd4b85

…check for private api

pr adding integration test

97326bc

minor documentation renaming to follow the pattern from the previous …

7e6a4a8

…example

Merge branch 'master' into ismaelmartinez/add-endpointconfiguration-f…

88233ac

…or-openapi3

This was referenced Jul 14, 2020

feat(apigateway): adding the ability to set the endpoint configuration for the OpenAPI 3.0 #9059

Closed

[apigateway] support configuring endpoint types for SpecRestApi (Swagger/OpenApi) #9060

Closed

SomayaB assigned nija-at Jul 15, 2020

IsmaelMartinez and others added 8 commits July 15, 2020 20:57

changing the name for the private api gateway integration test

4c4caf6

Merge branch 'ismaelmartinez/add-endpointconfiguration-for-openapi3' …

b63a0e2

…of github.com:IsmaelMartinez/aws-cdk into ismaelmartinez/add-endpointconfiguration-for-openapi3

updating integration tests after doing a test run in local

62c6832

Trying removing the 'expected' integration test as I can't see what i…

85ac49c

…s different

WIP reading the integration test file

7c2bbc0

wip: trying to workout the deployment ids for integration tests from …

2756fee

…the logs

removing the metatadata information from the integration test

f327d67

Merge branch 'master' into ismaelmartinez/add-endpointconfiguration-f…

51adf34

…or-openapi3

nija-at previously requested changes Jul 16, 2020

View reviewed changes

IsmaelMartinez added 2 commits July 16, 2020 16:48

PR changes.

43ff752

Merge branch 'ismaelmartinez/add-endpointconfiguration-for-openapi3' …

7a097a1

…of github.com:IsmaelMartinez/aws-cdk into ismaelmartinez/add-endpointconfiguration-for-openapi3

IsmaelMartinez and others added 7 commits July 16, 2020 17:08

adding an starting underscore to the new internal function

5fe131c

Merge branch 'master' into ismaelmartinez/add-endpointconfiguration-f…

dc6f5ec

…or-openapi3

Adding missing trailing comma in integration tests

0bdf82e

Merge branch 'master' into ismaelmartinez/add-endpointconfiguration-f…

2727182

…or-openapi3

removing tailing spaces

85092ad

Merge branch 'ismaelmartinez/add-endpointconfiguration-for-openapi3' …

6d3d066

…of github.com:IsmaelMartinez/aws-cdk into ismaelmartinez/add-endpointconfiguration-for-openapi3

Merge branch 'master' into ismaelmartinez/add-endpointconfiguration-f…

dfd0be0

…or-openapi3

IsmaelMartinez added 3 commits July 30, 2020 17:02

Merge branch 'master' into ismaelmartinez/add-endpointconfiguration-f…

f03fe62

…or-openapi3

Merge branch 'master' into ismaelmartinez/add-endpointconfiguration-f…

671dd0a

…or-openapi3

Merge branch 'master' into ismaelmartinez/add-endpointconfiguration-f…

6337b1a

…or-openapi3

nija-at mentioned this pull request Aug 3, 2020

fix(apigateway): allow endpointConfiguration to be defined #9177

Closed

nija-at previously requested changes Aug 4, 2020

View reviewed changes

modiry readme not to have a long line description

640b142

IsmaelMartinez and others added 6 commits August 4, 2020 15:58

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

4480b57

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

Adding endpoint configuration to the table of contents

ea29348

removing integration tests

efa3b94

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

80876ec

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

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

19ea67d

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

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

0af5923

Co-authored-by: Niranjan Jayakar <nija@amazon.com>

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

d224d73

nija-at approved these changes Aug 4, 2020

View reviewed changes

IsmaelMartinez commented Aug 4, 2020

View reviewed changes

packages/@aws-cdk/aws-apigateway/README.md Show resolved Hide resolved

Merge branch 'master' into ismaelmartinez/add-endpointconfiguration-f…

d165bba

…or-openapi3

mergify bot merged commit 7673e48 into aws:master Aug 4, 2020

IsmaelMartinez deleted the ismaelmartinez/add-endpointconfiguration-for-openapi3 branch March 11, 2021 15:18

fh17488 mentioned this pull request Jul 26, 2021

feat(apigateway): disableExecuteApiEndpoint in SpecRestApi does not work #15760

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(apigateway): configure endpoint types on SpecRestApi #9068

feat(apigateway): configure endpoint types on SpecRestApi #9068

IsmaelMartinez commented Jul 14, 2020 •

edited

Loading

IsmaelMartinez commented Jul 15, 2020 •

edited

Loading

IsmaelMartinez commented Jul 16, 2020

nija-at left a comment

nija-at Jul 16, 2020

IsmaelMartinez Jul 16, 2020

nija-at Aug 4, 2020

nija-at commented Aug 3, 2020

nija-at left a comment

nija-at Aug 4, 2020

IsmaelMartinez commented Aug 4, 2020

mergify bot commented Aug 4, 2020

aws-cdk-automation commented Aug 4, 2020

mergify bot commented Aug 4, 2020

jcrugzz commented Aug 7, 2020

IsmaelMartinez commented Aug 11, 2020

IsmaelMartinez commented Aug 14, 2020

feat(apigateway): configure endpoint types on SpecRestApi #9068

feat(apigateway): configure endpoint types on SpecRestApi #9068

Conversation

IsmaelMartinez commented Jul 14, 2020 • edited Loading

IsmaelMartinez commented Jul 15, 2020 • edited Loading

IsmaelMartinez commented Jul 16, 2020

nija-at left a comment

Choose a reason for hiding this comment

nija-at Jul 16, 2020

Choose a reason for hiding this comment

IsmaelMartinez Jul 16, 2020

Choose a reason for hiding this comment

nija-at Aug 4, 2020

Choose a reason for hiding this comment

nija-at commented Aug 3, 2020

nija-at left a comment

Choose a reason for hiding this comment

nija-at Aug 4, 2020

Choose a reason for hiding this comment

IsmaelMartinez commented Aug 4, 2020

mergify bot commented Aug 4, 2020

aws-cdk-automation commented Aug 4, 2020

AWS CodeBuild CI Report

mergify bot commented Aug 4, 2020

jcrugzz commented Aug 7, 2020

IsmaelMartinez commented Aug 11, 2020

IsmaelMartinez commented Aug 14, 2020

IsmaelMartinez commented Jul 14, 2020 •

edited

Loading

IsmaelMartinez commented Jul 15, 2020 •

edited

Loading