HttpAlbIntegration

class aws_cdk.aws_apigatewayv2_integrations.HttpAlbIntegration(id, listener, *, method=None, parameter_mapping=None, secure_server_name=None, vpc_link=None)

Bases: aws_cdk.aws_apigatewayv2.HttpRouteIntegration

(experimental) The Application Load Balancer integration resource for HTTP API.

Stability

experimental

ExampleMetadata

infused

Example:

from aws_cdk.aws_apigatewayv2_integrations import HttpAlbIntegration

# lb: elbv2.ApplicationLoadBalancer

listener = lb.add_listener("listener", port=80)
listener.add_targets("target",
    port=80
)

http_endpoint = apigwv2.HttpApi(self, "HttpProxyPrivateApi",
    default_integration=HttpAlbIntegration("DefaultIntegration", listener,
        parameter_mapping=apigwv2.ParameterMapping().custom("myKey", "myValue")
    )
)
Parameters
  • id (str) – id of the underlying integration construct.

  • listener (IApplicationListener) – the ELB application listener.

  • method (Optional[HttpMethod]) – (experimental) The HTTP method that must be used to invoke the underlying HTTP proxy. Default: HttpMethod.ANY

  • parameter_mapping (Optional[ParameterMapping]) – (experimental) Specifies how to transform HTTP requests before sending them to the backend. Default: undefined requests are sent to the backend unmodified

  • secure_server_name (Optional[str]) – (experimental) Specifies the server name to verified by HTTPS when calling the backend integration. Default: undefined private integration traffic will use HTTP protocol

  • vpc_link (Optional[IVpcLink]) – (experimental) The vpc link to be used for the private integration. Default: - a new VpcLink is created

Stability

experimental

Methods

bind(*, route, scope)

(experimental) Bind this integration to the route.

Parameters
  • route (IHttpRoute) – (experimental) The route to which this is being bound.

  • scope (Construct) – (experimental) The current scope in which the bind is occurring. If the HttpRouteIntegration being bound creates additional constructs, this will be used as their parent scope.

Stability

experimental

Return type

HttpRouteIntegrationConfig