HttpPrivateIntegrationOptions

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

Bases: object

(experimental) Base options for private integration.

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

Attributes

method

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

Default

HttpMethod.ANY

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]

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]

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

Default
  • a new VpcLink is created

Stability

experimental

Return type

Optional[IVpcLink]