HttpIntegrationProps

class aws_cdk.aws_apigatewayv2.HttpIntegrationProps(*, http_api, integration_type, integration_uri, connection_id=None, connection_type=None, method=None, payload_format_version=None)

Bases: object

(experimental) The integration properties.

Parameters
  • http_api (IHttpApi) – (experimental) The HTTP API to which this integration should be bound.

  • integration_type (HttpIntegrationType) – (experimental) Integration type.

  • integration_uri (str) – (experimental) Integration URI. This will be the function ARN in the case of HttpIntegrationType.LAMBDA_PROXY, or HTTP URL in the case of HttpIntegrationType.HTTP_PROXY.

  • connection_id (Optional[str]) – (experimental) The ID of the VPC link for a private integration. Supported only for HTTP APIs. Default: - undefined

  • connection_type (Optional[HttpConnectionType]) – (experimental) The type of the network connection to the integration endpoint. Default: HttpConnectionType.INTERNET

  • method (Optional[HttpMethod]) – (experimental) The HTTP method to use when calling the underlying HTTP proxy. Default: - none. required if the integration type is HttpIntegrationType.HTTP_PROXY.

  • payload_format_version (Optional[PayloadFormatVersion]) – (experimental) The version of the payload format. Default: - defaults to latest in the case of HttpIntegrationType.LAMBDA_PROXY`, irrelevant otherwise.

Stability

experimental

Attributes

connection_id

(experimental) The ID of the VPC link for a private integration.

Supported only for HTTP APIs.

Default
  • undefined

Stability

experimental

Return type

Optional[str]

connection_type

(experimental) The type of the network connection to the integration endpoint.

Default

HttpConnectionType.INTERNET

Stability

experimental

Return type

Optional[HttpConnectionType]

http_api

(experimental) The HTTP API to which this integration should be bound.

Stability

experimental

Return type

IHttpApi

integration_type

(experimental) Integration type.

Stability

experimental

Return type

HttpIntegrationType

integration_uri

(experimental) Integration URI.

This will be the function ARN in the case of HttpIntegrationType.LAMBDA_PROXY, or HTTP URL in the case of HttpIntegrationType.HTTP_PROXY.

Stability

experimental

Return type

str

method

(experimental) The HTTP method to use when calling the underlying HTTP proxy.

Default
  • none. required if the integration type is HttpIntegrationType.HTTP_PROXY.

Stability

experimental

Return type

Optional[HttpMethod]

payload_format_version

(experimental) The version of the payload format.

Default
  • defaults to latest in the case of HttpIntegrationType.LAMBDA_PROXY`, irrelevant otherwise.

See

https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html

Stability

experimental

Return type

Optional[PayloadFormatVersion]