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.ANYparameter_mapping (
Optional
[ParameterMapping
]) – (experimental) 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
]) – (experimental) Specifies the server name to verified by HTTPS when calling the backend integration. Default: undefined private integration traffic will use HTTP protocolvpc_link (
Optional
[IVpcLink
]) – (experimental) The vpc link to be used for the private integration. Default: - a new VpcLink is created
- 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 import aws_cdk.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", vpc_link=vpc_link )
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
- Stability
experimental
- Return type
Optional
[str
]