跳到主要内容

参数​

请参阅插件通用配置,了解所有插件通用的配置选项。

  • function_uri

    string

    必填


    触发 Lambda 函数的 AWS Lambda 函数 URL 或 Amazon API Gateway 端点。在 API7 企业版 3.9.20、3.10.7 和 APISIX 3.19.0 中,不含路径的端点使用 / 作为请求路径。

  • authorization

    object


    添加到发往 AWS 的请求中的凭证或 API Key。IAM 凭证用于 SigV4 签名。API Gateway API Key 用于标识用量计划中的调用方,不提供身份认证或授权。

    • apikey

      string


      添加到发往 Amazon API Gateway REST API 的 X-API-Key 请求头中的 API Key。API Gateway 用它标识用量计划和配额中的调用方,而不是执行身份认证或授权。API7 网关会在静态存储时使用 AES 加密该值;当启用 apisix.data_encryption.enable_encrypt_fields 时,APISIX 会在将其存储到 etcd 前加密。

    • iam

      object


      用于通过 AWS Signature Version 4 对请求签名的 IAM 访问密钥。插件不接受会话令牌。

      • accesskey

        string

        必填


        IAM 访问密钥 ID。API7 网关会在静态存储时使用 AES 加密该值;当启用 apisix.data_encryption.enable_encrypt_fields 时,APISIX 会在将其存储到 etcd 前加密。

      • secretkey

        string

        必填


        IAM 秘密访问密钥。API7 网关会在静态存储时使用 AES 加密该值;当启用 apisix.data_encryption.enable_encrypt_fields 时,APISIX 会在将其存储到 etcd 前加密。

      • aws_region

        string

        默认值:us-east-1


        AWS 区域。

      • service

        string

        默认值:execute-api


        接收请求的服务。

        对于 Amazon API Gateway 端点,将此值设置为 execute-api。

        对于 Lambda 函数 URL,将此值设置为 lambda。

  • timeout

    integer

    默认值:3000

    有效值:

    大于或等于 100


    代理请求超时时间(以毫秒为单位)。

  • ssl_verify

    boolean

    默认值:true


    如果为 true,则验证上游 TLS 证书。

  • keepalive

    boolean

    默认值:true


    如果为 true,则保持连接活动以便重用。

  • keepalive_pool

    integer

    默认值:5

    有效值:

    大于或等于 1


    keepalive 连接池中的最大连接数。

  • keepalive_timeout

    integer

    默认值:60000

    有效值:

    大于或等于 1000


    连接保持空闲而不关闭的时间(以毫秒为单位)。

  • max_req_body_size

    integer

    默认值:67108864

    有效值:

    大于或等于 1


    发往所配置 AWS 端点前,在内存中缓冲的请求体最大字节数。超过该大小的请求体会以 400 Bad Request 被拒绝。自 API7 企业版 3.9.17 和 3.10.4 以及 APISIX 3.18.0 起引入。