HttpPrivateIntegrationOptions
- class aws_cdk.aws_apigatewayv2_integrations.HttpPrivateIntegrationOptions(*, method=None, parameter_mapping=None, secure_server_name=None, timeout=None, vpc_link=None)
Bases:
object
Base options for private integration.
- Parameters:
method (
Optional
[HttpMethod
]) – The HTTP method that must be used to invoke the underlying HTTP proxy. Default: HttpMethod.ANYparameter_mapping (
Optional
[ParameterMapping
]) – Specifies how to transform HTTP requests before sending them to the backend. Default: undefined requests are sent to the backend unmodifiedsecure_server_name (
Optional
[str
]) – Specifies the server name to verified by HTTPS when calling the backend integration. Default: undefined private integration traffic will use HTTP protocoltimeout (
Optional
[Duration
]) – The maximum amount of time an integration will run before it returns without a response. Must be between 50 milliseconds and 29 seconds. Default: Duration.seconds(29)vpc_link (
Optional
[IVpcLink
]) – The vpc link to be used for the private integration. Default: - a new VpcLink is created
- 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 as cdk from aws_cdk import aws_apigatewayv2 as apigatewayv2 from aws_cdk import aws_apigatewayv2_integrations as apigatewayv2_integrations # parameter_mapping: apigatewayv2.ParameterMapping # vpc_link: apigatewayv2.VpcLink http_private_integration_options = apigatewayv2_integrations.HttpPrivateIntegrationOptions( method=apigatewayv2.HttpMethod.ANY, parameter_mapping=parameter_mapping, secure_server_name="secureServerName", timeout=cdk.Duration.minutes(30), vpc_link=vpc_link )
Attributes
- method
The HTTP method that must be used to invoke the underlying HTTP proxy.
- Default:
HttpMethod.ANY
- parameter_mapping
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
- secure_server_name
Specifies the server name to verified by HTTPS when calling the backend integration.
- Default:
undefined private integration traffic will use HTTP protocol
- See:
- timeout
The maximum amount of time an integration will run before it returns without a response.
Must be between 50 milliseconds and 29 seconds.
- Default:
Duration.seconds(29)
- vpc_link
The vpc link to be used for the private integration.
- Default:
a new VpcLink is created