HttpIntegrationProps

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

Bases: object

(experimental) The integration properties.

Parameters
  • 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

  • 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.

  • 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.

  • 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

  • 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.

  • secure_server_name (Optional[str]) – (experimental) Specifies the TLS configuration for a private integration. Default: undefined private integration traffic will use HTTP protocol

Stability

experimental

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

# http_api is of type HttpApi
# parameter_mapping is of type ParameterMapping
# payload_format_version is of type PayloadFormatVersion

http_integration_props = apigatewayv2.HttpIntegrationProps(
    http_api=http_api,
    integration_type=apigatewayv2.HttpIntegrationType.LAMBDA_PROXY,
    integration_uri="integrationUri",

    # the properties below are optional
    connection_id="connectionId",
    connection_type=apigatewayv2.HttpConnectionType.VPC_LINK,
    method=apigatewayv2.HttpMethod.ANY,
    parameter_mapping=parameter_mapping,
    payload_format_version=payload_format_version,
    secure_server_name="secureServerName"
)

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]

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

Return type

Optional[ParameterMapping]

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]

secure_server_name

(experimental) Specifies the TLS configuration for a private 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

Return type

Optional[str]