Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[apigateway] SpecRestAPI x-amazon-apigateway-endpoint-configuration not usable for private API initial deployment #9588

Closed
IsmaelMartinez opened this issue Aug 11, 2020 · 1 comment
Closed

[apigateway] SpecRestAPI x-amazon-apigateway-endpoint-configuration not usable for private API initial deployment #9588

IsmaelMartinez opened this issue Aug 11, 2020 · 1 comment
Assignees
@nija-at
Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway documentation This is a problem with documentation. feature-request A feature should be added or improved. in-progress This issue is being actively worked on. needs-triage This issue or PR still needs to be triaged.

Comments

@IsmaelMartinez
Copy link
Contributor

IsmaelMartinez commented Aug 11, 2020 •
edited
Loading

It is not possible to use the swagger/openAPI x-amazon-apigateway-endpoint-configuration option in conjunction with the private endpointType.

If you specify a vpce in the endpoint configuration, you get the following:

VPCEndpoints can only be specified with PRIVATE apis. (Service: AmazonApiGateway; Status Code: 400; Error Code: BadRequestException; Request ID: a2a6cebc-7004-4884-9398-0b83a384b49c)
	new SpecRestApi (/Users/ismael.martinez/projects/bitbucket/BIP/draw/draw-scheduler/node_modules/@aws-cdk/aws-apigateway/lib/restapi.ts:486:22)
...

PR submitted in #9590

https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-apigateway/README.md#endpoint-configuration

This is a 📕 documentation issue
@IsmaelMartinez IsmaelMartinez added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Aug 11, 2020
IsmaelMartinez added a commit to IsmaelMartinez/aws-cdk that referenced this issue Aug 11, 2020
@IsmaelMartinez
Removing the reference to x-amazon-apigateway-endpoint-configuration …
db49482 
…for private api gateway using openapi

Removing the reference to x-amazon-apigateway-endpoint-configuration for private api gateway using openapi. 

This fixes aws#9588
@github-actions github-actions bot added the @aws-cdk/aws-apigateway Related to Amazon API Gateway label Aug 11, 2020
This was referenced Aug 11, 2020
Closed
Merged
IsmaelMartinez added a commit to IsmaelMartinez/aws-cdk that referenced this issue Aug 11, 2020
@IsmaelMartinez
docs(apigateway): Removing the reference to x-amazon-apigateway-endpo…
a37c6e1 
…int-configuration for private api gateway using openapi

Removing the reference to x-amazon-apigateway-endpoint-configuration for private api gateway using openapi.

This fixes aws#9588
@IsmaelMartinez IsmaelMartinez mentioned this issue Aug 11, 2020
Closed
@SomayaB SomayaB added the in-progress This issue is being actively worked on. label Aug 11, 2020
@IsmaelMartinez IsmaelMartinez changed the title [apigateway] SpecRestAPI x-amazon-apigateway-endpoint-configuration not usable for private API [apigateway] SpecRestAPI x-amazon-apigateway-endpoint-configuration not usable for private API initial deployment Aug 13, 2020
@IsmaelMartinez
Copy link
Contributor Author

closing this as it is not a documentation issue but a real issue. #9684

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nija-at nija-at

Labels
@aws-cdk/aws-apigateway Related to Amazon API Gateway documentation This is a problem with documentation. feature-request A feature should be added or improved. in-progress This issue is being actively worked on. needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Milestone
No milestone
3 participants
@IsmaelMartinez @nija-at @SomayaB