IntegrationType

class aws_cdk.aws_apigateway.IntegrationType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

ExampleMetadata:

infused

Example:

import aws_cdk.aws_elasticloadbalancingv2 as elbv2


vpc = ec2.Vpc(self, "VPC")
nlb = elbv2.NetworkLoadBalancer(self, "NLB",
    vpc=vpc
)
link = apigateway.VpcLink(self, "link",
    targets=[nlb]
)

integration = apigateway.Integration(
    type=apigateway.IntegrationType.HTTP_PROXY,
    integration_http_method="ANY",
    options=apigateway.IntegrationOptions(
        connection_type=apigateway.ConnectionType.VPC_LINK,
        vpc_link=link
    )
)

Attributes

AWS

For integrating the API method request with an AWS service action, including the Lambda function-invoking action.

With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

AWS_PROXY

For integrating the API method request with the Lambda function-invoking action with the client request passed through as-is.

This integration is also referred to as the Lambda proxy integration

HTTP

For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC.

This integration is also referred to as the HTTP custom integration.

HTTP_PROXY

For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is.

This is also referred to as the HTTP proxy integration

MOCK

For integrating the API method request with API Gateway as a “loop-back” endpoint without invoking any backend.