Créez des intégrations privées pour HTTP APIs dans Gateway API

Les intégrations privées vous permettent de créer des API intégrations avec des ressources privées dans unVPC, telles que les équilibreurs de charge d'application ou les applications basées sur des conteneurs AmazonECS.

Vous pouvez exposer vos ressources dans un espace accessible VPC à des clients extérieurs à l'aide VPC d'intégrations privées. Vous pouvez contrôler l'accès à votre API en utilisant l'une des méthodes d'autorisation prises en charge par API Gateway.

Pour créer une intégration privée, vous devez d'abord créer un VPC lien. Pour en savoir plus sur VPC les liens, voirConfigurer VPC des liens pour HTTP APIs dans API Gateway.

Après avoir créé un VPC lien, vous pouvez configurer des intégrations privées qui se connectent à un Application Load Balancer, à un Network Load Balancer ou à des ressources enregistrées auprès d'un service. AWS Cloud Map

Pour créer une intégration privée, toutes les ressources doivent appartenir au même AWS compte (y compris l'équilibreur de charge ou le AWS Cloud Map service, le VPC lien et HTTPAPI).

Par défaut, le trafic d'intégration privé utilise le HTTP protocole. Vous pouvez spécifier un tlsConfigsi vous souhaitez utiliser du trafic d'intégration privéHTTPS. Pour ce faire AWS Management Console, lorsque vous créez votre intégration privée, choisissez Paramètres avancés, puis entrez un nom de serveur sécurisé.

Note

Pour les intégrations privées, API Gateway inclut la partie étape du point de API terminaison dans la demande adressée aux ressources de votre backend. Par exemple, une demande au test stade d'une inclusion API test/route-path dans la demande relative à votre intégration privée. Pour supprimer le nom de l’étape de la demande pour vos ressources backend, utilisez le mappage de paramètres pour écraser le chemin d'accès à la requête vers $request.path.

Créer une intégration privée à l'aide de Application Load Balancer ou de Network Load Balancer

Avant de créer une intégration privée, vous devez créer un VPC lien. Pour en savoir plus sur VPC les liens, voirConfigurer VPC des liens pour HTTP APIs dans API Gateway.

Pour créer une intégration privée avec un Application Load Balancer ou un Network Load Balancer, créez HTTP une intégration proxy, spécifiez VPC le lien à utiliser et fournissez l'ARNécouteur de l'équilibreur de charge.

Utilisez la commande suivante pour créer une intégration privée qui se connecte à un équilibreur de charge à l'aide d'un VPC lien.

aws apigatewayv2 create-integration --api-id api-id --integration-type HTTP_PROXY \
    --integration-method GET --connection-type VPC_LINK \
    --connection-id VPC-link-ID \
    --integration-uri arn:aws:elasticloadbalancing:us-east-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65
    --payload-format-version 1.0

Création d'une intégration privée à l'aide de la découverte AWS Cloud Map de services

Avant de créer une intégration privée, vous devez créer un VPC lien. Pour en savoir plus sur VPC les liens, voirConfigurer VPC des liens pour HTTP APIs dans API Gateway.

Pour les intégrations avec AWS Cloud Map, API Gateway les utilise DiscoverInstances pour identifier les ressources. Vous pouvez utiliser des paramètres de requête pour cibler des ressources spécifiques. Les attributs des ressources enregistrées doivent inclure les adresses IP et les ports. APIGateway distribue les demandes entre les ressources saines renvoyées parDiscoverInstances. Pour en savoir plus, reportez-vous DiscoverInstancesà la section AWS Cloud Map API Référence.

Note

Si vous utilisez Amazon ECS pour renseigner des entrées AWS Cloud Map, vous devez configurer votre ECS tâche Amazon pour utiliser SRV les enregistrements avec Amazon ECS Service Discovery ou activer Amazon ECS Service Connect. Pour en savoir plus, consultez Interconnexion des services dans le Guide du développeur Amazon Elastic Container Service.

Pour créer une intégration privée avec AWS Cloud Map, créez une intégration HTTP proxy, spécifiez le VPC lien à utiliser et fournissez le ARN AWS Cloud Map service.

Utilisez la commande suivante pour créer une intégration privée qui utilise la découverte AWS Cloud Map de services pour identifier les ressources.

aws apigatewayv2 create-integration --api-id api-id --integration-type HTTP_PROXY  \
    --integration-method GET --connection-type VPC_LINK \
    --connection-id VPC-link-ID \
    --integration-uri arn:aws:servicediscovery:us-east-2:123456789012:service/srv-id?stage=prod&deployment=green_deployment
    --payload-format-version 1.0