Bases: IntegrationOptions
cache_key_parameters (Optional[Sequence[str]]) â A list of request parameters whose values are to be cached. It determines request parameters that will make it into the cache key.
cache_namespace (Optional[str]) â An API-specific tag group of related cached parameters.
connection_type (Optional[ConnectionType]) â The type of network connection to the integration endpoint. Default: - ConnectionType.VPC_LINK if vpcLink property is configured; ConnectionType.Internet otherwise.
content_handling (Optional[ContentHandling]) â Specifies how to handle request payload content type conversions. Default: none if this property isnât defined, the request payload is passed through from the method request to the integration request without modification, provided that the passthroughBehaviors property is configured to support payload pass-through.
credentials_passthrough (Optional[bool]) â Requires that the callerâs identity be passed through from the request. Default: Caller identity is not passed through
credentials_role (Optional[IRole]) â An IAM role that API Gateway assumes. Mutually exclusive with credentialsPassThrough. Default: A role is not assumed
integration_responses (Optional[Sequence[Union[IntegrationResponse, Dict[str, Any]]]]) â The response that API Gateway provides after a methodâs backend completes processing a request. API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.
passthrough_behavior (Optional[PassthroughBehavior]) â Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
request_parameters (Optional[Mapping[str, str]]) â The request parameters that API Gateway sends with the backend request. Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value. Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name. The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.
request_templates (Optional[Mapping[str, str]]) â A map of Apache Velocity templates that are applied on the request payload. The template that API Gateway uses is based on the value of the Content-Type header thatâs sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:: { âapplication/jsonâ: â{ "statusCode": 200 }â }
timeout (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 VpcLink used for the integration. Required if connectionType is VPC_LINK
allow_test_invoke (Optional[bool]) â Allow invoking method from AWS Console UI (for testing purposes). This will add another permission to the AWS Lambda resource policy which will allow the test-invoke-stage stage to invoke this handler. If this is set to false, the function will only be usable from the deployment endpoint. Default: true
proxy (Optional[bool]) â Use proxy integration or normal (request/response mapping) integration. Default: true
infused
Example:
# get_book_handler: lambda.Function
# get_book_integration: apigateway.LambdaIntegration
get_book_integration = apigateway.LambdaIntegration(get_book_handler,
content_handling=apigateway.ContentHandling.CONVERT_TO_TEXT, # convert to base64
credentials_passthrough=True
)
Attributes
Allow invoking method from AWS Console UI (for testing purposes).
This will add another permission to the AWS Lambda resource policy which will allow the test-invoke-stage stage to invoke this handler. If this is set to false, the function will only be usable from the deployment endpoint.
true
A list of request parameters whose values are to be cached.
It determines request parameters that will make it into the cache key.
An API-specific tag group of related cached parameters.
The type of network connection to the integration endpoint.
ConnectionType.VPC_LINK if vpcLink property is configured; ConnectionType.Internet otherwise.
Specifies how to handle request payload content type conversions.
none if this property isnât defined, the request payload is passed through from the method request to the integration request without modification, provided that the passthroughBehaviors property is configured to support payload pass-through.
Requires that the callerâs identity be passed through from the request.
Caller identity is not passed through
An IAM role that API Gateway assumes.
Mutually exclusive with credentialsPassThrough.
A role is not assumed
The response that API Gateway provides after a methodâs backend completes processing a request.
API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
Use proxy integration or normal (request/response mapping) integration.
The request parameters that API Gateway sends with the backend request.
Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.
Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name.
The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.
A map of Apache Velocity templates that are applied on the request payload.
The template that API Gateway uses is based on the value of the Content-Type header thatâs sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:
{ "application/json": "{ \"statusCode\": 200 }" }
The maximum amount of time an integration will run before it returns without a response.
Must be between 50 milliseconds and 29 seconds.
Duration.seconds(29)
The VpcLink used for the integration.
Required if connectionType is VPC_LINK
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4