HttpRouteIntegrationConfig

class aws_cdk.aws_apigatewayv2.HttpRouteIntegrationConfig(*, payload_format_version, type, connection_id=None, connection_type=None, credentials=None, method=None, parameter_mapping=None, secure_server_name=None, subtype=None, uri=None)

Bases: object

(experimental) Config returned back as a result of the bind.

Parameters
  • payload_format_version (PayloadFormatVersion) – (experimental) Payload format version in the case of lambda proxy integration. Default: - undefined

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

  • 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

  • credentials (Optional[IntegrationCredentials]) – (experimental) The credentials with which to invoke the integration. Default: - no credentials, use resource-based permissions on supported AWS services

  • method (Optional[HttpMethod]) – (experimental) The HTTP method that must be used to invoke the underlying proxy. Required for HttpIntegrationType.HTTP_PROXY Default: - undefined

  • 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

  • subtype (Optional[HttpIntegrationSubtype]) – (experimental) Integration subtype. Default: - none, required if no integrationUri is defined.

  • uri (Optional[str]) – (experimental) Integration URI. Default: - none, required if no integrationSubtype is defined.

Stability

experimental

ExampleMetadata

fixture=_generated

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

# integration_credentials: apigatewayv2.IntegrationCredentials
# parameter_mapping: apigatewayv2.ParameterMapping
# payload_format_version: apigatewayv2.PayloadFormatVersion

http_route_integration_config = apigatewayv2.HttpRouteIntegrationConfig(
    payload_format_version=payload_format_version,
    type=apigatewayv2.HttpIntegrationType.HTTP_PROXY,

    # the properties below are optional
    connection_id="connectionId",
    connection_type=apigatewayv2.HttpConnectionType.VPC_LINK,
    credentials=integration_credentials,
    method=apigatewayv2.HttpMethod.ANY,
    parameter_mapping=parameter_mapping,
    secure_server_name="secureServerName",
    subtype=apigatewayv2.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
    uri="uri"
)

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]

credentials

(experimental) The credentials with which to invoke the integration.

Default
  • no credentials, use resource-based permissions on supported AWS services

Stability

experimental

Return type

Optional[IntegrationCredentials]

method

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

Required for HttpIntegrationType.HTTP_PROXY

Default
  • undefined

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) Payload format version in the case of lambda proxy integration.

Default
  • undefined

See

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

Stability

experimental

Return type

PayloadFormatVersion

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

Return type

Optional[str]

subtype

(experimental) Integration subtype.

Default
  • none, required if no integrationUri is defined.

Stability

experimental

Return type

Optional[HttpIntegrationSubtype]

type

(experimental) Integration type.

Stability

experimental

Return type

HttpIntegrationType

uri

(experimental) Integration URI.

Default
  • none, required if no integrationSubtype is defined.

Stability

experimental

Return type

Optional[str]