AWS Lambda Configuration

Configuration reference for the AWS Lambda plugin (`aws-lambda`): the attributes and parameters, each attribute with its type, whether it is required, its default and its accepted values.

Parameters

See plugin common configurations (opens in Apache APISIX docs) for configuration options available to all plugins.

function_uri — string · required · since APISIX 2.12.0 · API7 Gateway 3.9.7

AWS Lambda function URL or AWS API gateway endpoint that triggers the Lambda function.

authorization — object · optional · since APISIX 2.12.0 · API7 Gateway 3.9.7

Credentials used in authentication and authorization on AWS to invoke Lambda function.

apikey — string · optional

API key for the REST API gateway when API key is selected as the security mechanism. API7 Gateway encrypts the value with AES at rest. APISIX encrypts it before etcd storage when apisix.data_encryption.enable_encrypt_fields is enabled.

iam — object · optional

IAM credentials to be authenticated using AWS Signature Version 4 and authorized.

accesskey — string · optional

IAM user access key. API7 Gateway encrypts the value with AES at rest. APISIX encrypts it before etcd storage when apisix.data_encryption.enable_encrypt_fields is enabled.

secretkey — string · optional

IAM user secret access key. API7 Gateway encrypts the value with AES at rest. APISIX encrypts it before etcd storage when apisix.data_encryption.enable_encrypt_fields is enabled.

aws_region — string · optional · default: us-east-1

AWS region.

service — string · optional · default: execute-api

Service receiving the request.

To integrate with AWS API gateway for API execution, set the service to execute-api for HTTP trigger.

To integrate with Lambda function directly, set the service to lambda.

timeout — integer · optional · default: 3000 · since APISIX 2.12.0 · API7 Gateway 3.9.7

Valid values: greater than or equal to 100

Proxy request timeout in milliseconds.

ssl_verify — boolean · optional · default: true · since APISIX 2.12.0 · API7 Gateway 3.9.7

If true, perform SSL verification.

keepalive — boolean · optional · default: true · since APISIX 2.12.0 · API7 Gateway 3.9.7

If true, keep the connection alive for reuse.

keepalive_pool — integer · optional · default: 5 · since APISIX 2.12.0 · API7 Gateway 3.9.7

Valid values: greater than or equal to 1

If true, keep the connection alive for reuse.

keepalive_timeout — integer · optional · default: 60000 · since APISIX 2.12.0 · API7 Gateway 3.9.7

Valid values: greater than or equal to 1000

Time for connection to remain idle without closing in milliseconds.

max_req_body_size — integer · optional · default: 67108864 · since APISIX 3.18.0 · API7 Gateway 3.9.17

Valid values: greater than or equal to 1

Maximum request body size in bytes read before the request is sent to AWS Lambda. A larger body is rejected with 400 Bad Request. Introduced in API7 Enterprise 3.9.17 and 3.10.4, and APISIX 3.18.0.

AWS Lambda Configuration

Attributes

Parameters