HttpAlbIntegrationProps

class aws_cdk.aws_apigatewayv2_integrations.HttpAlbIntegrationProps(*, method=None, parameter_mapping=None, secure_server_name=None, vpc_link=None)

Bases: HttpPrivateIntegrationOptions

(experimental) Properties to initialize HttpAlbIntegration.

Parameters:

  • 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

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().append_header("header2", apigwv2.MappingValue.request_header("header1")).remove_header("header1")
    )
)

Attributes

method

(experimental) The HTTP method that must be used to invoke the underlying HTTP proxy.

Default:

HttpMethod.ANY

Stability:

experimental

parameter_mapping

(experimental) Specifies how to transform HTTP requests before sending them to the backend.

Default:

undefined requests are sent to the backend unmodified

See:

https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

Stability:

experimental

secure_server_name

(experimental) Specifies the server name to verified by HTTPS when calling the backend integration.

Default:

undefined private integration traffic will use HTTP protocol

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html

Stability:

experimental

(experimental) The vpc link to be used for the private integration.

Default:

  • a new VpcLink is created

Stability:

experimental