AWS apigateway documentation change
Summary
Updated documentation to reference VPC links V2, added considerations section with security-related HTTPS configuration details, and reorganized content about private integration requirements
Security assessment
The changes emphasize HTTPS usage via tlsConfig (security feature documentation) but do not address a specific vulnerability. The VPC links V2 introduction appears to be a feature update rather than a security fix. The documentation now explicitly highlights secure configuration options, which improves security awareness.
Diff
diff --git a/apigateway/latest/developerguide/http-api-develop-integrations-private.md b/apigateway/latest/developerguide/http-api-develop-integrations-private.md index 915fe4034..377d0c0bd 100644 --- a//apigateway/latest/developerguide/http-api-develop-integrations-private.md +++ b//apigateway/latest/developerguide/http-api-develop-integrations-private.md @@ -5 +5 @@ -Create a private integration using an Application Load Balancer or Network Load Balancer Create a private integration using AWS Cloud Map service discovery +ConsiderationsCreate a private integration using an Application Load Balancer or Network Load Balancer Create a private integration using AWS Cloud Map service discovery @@ -13 +13 @@ You can expose your resources in a VPC for access by clients outside of the VPC -To create a private integration, you must first create a VPC link. To learn more about VPC links, see [Set up VPC links for HTTP APIs in API Gateway](./http-api-vpc-links.html). +###### Note @@ -15 +15 @@ To create a private integration, you must first create a VPC link. To learn more -After you’ve created a VPC link, you can set up private integrations that connect to an Application Load Balancer, Network Load Balancer, or resources registered with an AWS Cloud Map service. +To create a private integration, you must first create a VPC link. VPC links V2 are now supported for both HTTP and REST APIs. To learn more about VPC links V2, see [Set up VPC links V2 in API Gateway](./apigateway-vpc-links-v2.html). @@ -17 +17,11 @@ After you’ve created a VPC link, you can set up private integrations that conn -To create a private integration, all resources must be owned by the same AWS account (including the load balancer or AWS Cloud Map service, VPC link and HTTP API). +After you’ve created a VPC link V2, you can set up private integrations that connect to an Application Load Balancer, Network Load Balancer, or resources registered with an AWS Cloud Map service. + +## Considerations + +The following considerations might impact your use of private integrations: + + * All resources must be owned by the same AWS account. This includes the load balancer or AWS Cloud Map service, VPC link and HTTP API. + + * By default, private integration traffic uses the HTTP protocol. To use HTTPS, specify a [`tlsConfig`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid.html). To do this using the AWS Management Console, when you create your private integration, choose **Advanced settings** and then enter a secure server name. + + * For private integrations, API Gateway includes the [stage](./http-api-stages.html) portion of the API endpoint in the request to your backend resources. For example, a request to the `test` stage of an API includes `test/`route-path`` in the request to your private integration. To remove the stage name from the request to your backend resources, use [parameter mapping](./http-api-parameter-mapping.html) to overwrite the request path to `$request.path`. @@ -19 +28,0 @@ To create a private integration, all resources must be owned by the same AWS acc -By default, private integration traffic uses the HTTP protocol. You can specify a [`tlsConfig`](https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/apis-apiid-integrations-integrationid.html) if you require private integration traffic to use HTTPS. To do this using the AWS Management Console, when you create your private integration, choose **Advanced settings** and then enter a secure server name. @@ -21 +29,0 @@ By default, private integration traffic uses the HTTP protocol. You can specify -###### Note @@ -23 +30,0 @@ By default, private integration traffic uses the HTTP protocol. You can specify -For private integrations, API Gateway includes the [stage](./http-api-stages.html) portion of the API endpoint in the request to your backend resources. For example, a request to the `test` stage of an API includes `test/`route-path`` in the request to your private integration. To remove the stage name from the request to your backend resources, use [parameter mapping](./http-api-parameter-mapping.html) to overwrite the request path to `$request.path`. @@ -27 +34 @@ For private integrations, API Gateway includes the [stage](./http-api-stages.htm -Before you create a private integration, you must create a VPC link. To learn more about VPC links, see [Set up VPC links for HTTP APIs in API Gateway](./http-api-vpc-links.html). +Before you create a private integration, you must create a VPC link V2. To learn more about VPC links V2, see [Set up VPC links V2 in API Gateway](./apigateway-vpc-links-v2.html). @@ -42 +49 @@ The following [create-integration](https://docs.aws.amazon.com/cli/latest/refere -Before you create a private integration, you must create a VPC link. To learn more about VPC links, see [Set up VPC links for HTTP APIs in API Gateway](./http-api-vpc-links.html). +Before you create a private integration, you must create a VPC link V2. To learn more about VPC links, see [Set up VPC links V2 in API Gateway](./apigateway-vpc-links-v2.html). @@ -69 +76 @@ AWS service integrations reference -VPC links +CORS