LambdaIntegrationOptions

class aws_cdk.aws_apigateway.LambdaIntegrationOptions(*, cache_key_parameters=None, cache_namespace=None, connection_type=None, content_handling=None, credentials_passthrough=None, credentials_role=None, integration_responses=None, passthrough_behavior=None, request_parameters=None, request_templates=None, timeout=None, vpc_link=None, allow_test_invoke=None, proxy=None)

Bases: IntegrationOptions

Parameters:
  • 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. By default, the value must be between 50 milliseconds and 29 seconds. The upper bound can be increased for regional and private Rest APIs only, via a quota increase request for your acccount. This increase might require a reduction in your account-level throttle quota limit. See {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html Amazon API Gateway quotas} for more details. 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

ExampleMetadata:

infused

Example:

# backend: lambda.Function


api = apigateway.LambdaRestApi(self, "myapi",
    handler=backend,
    integration_options=apigateway.LambdaIntegrationOptions(
        allow_test_invoke=False,
        timeout=Duration.seconds(1)
    )
)

Attributes

allow_test_invoke

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

cache_key_parameters

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

An API-specific tag group of related cached parameters.

connection_type

The type of network connection to the integration endpoint.

Default:
  • ConnectionType.VPC_LINK if vpcLink property is configured; ConnectionType.Internet otherwise.

content_handling

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

Requires that the caller’s identity be passed through from the request.

Default:

Caller identity is not passed through

credentials_role

An IAM role that API Gateway assumes.

Mutually exclusive with credentialsPassThrough.

Default:

A role is not assumed

integration_responses

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

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.

proxy

Use proxy integration or normal (request/response mapping) integration.

Default:

true

See:

https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format

request_parameters

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

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 }" }
See:

http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html

timeout

The maximum amount of time an integration will run before it returns without a response.

By default, the value must be between 50 milliseconds and 29 seconds. The upper bound can be increased for regional and private Rest APIs only, via a quota increase request for your acccount. This increase might require a reduction in your account-level throttle quota limit.

See {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html Amazon API Gateway quotas} for more details.

Default:

Duration.seconds(29)

The VpcLink used for the integration.

Required if connectionType is VPC_LINK