Skip to main content
API7.ai Logo

Attributes​

Parameters​

See plugin common configurations for configuration options available to all plugins.

  • function_uri

    string

    required

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

  • authorization

    object

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

    • apikey

      string

      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

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

      • accesskey

        string

        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

        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

        default: us-east-1

        AWS region.

      • service

        string

        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

    default: 3000

    vaild vaule:

    greater than or equal to 100

    Proxy request timeout in milliseconds.

  • ssl_verify

    boolean

    default: true

    If true, perform SSL verification.

  • keepalive

    boolean

    default: true

    If true, keep the connection alive for reuse.

  • keepalive_pool

    integer

    default: 5

    vaild vaule:

    greater than or equal to 1

    If true, keep the connection alive for reuse.

  • keepalive_timeout

    integer

    default: 60000

    vaild vaule:

    greater than or equal to 1000

    Time for connection to remain idle without closing in milliseconds.

  • max_req_body_size

    integer

    default: 67108864

    vaild vaule:

    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.