AwsLambdaPluginConfig

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AwsLambdaPluginConfig",
  "title": "AwsLambdaPluginConfig",
  "x-speakeasy-entity": "PluginAwsLambda",
  "properties": {
    "config": {
      "type": "object",
      "properties": {
        "aws_assume_role_arn": {
          "description": "The target AWS IAM role ARN used to invoke the Lambda function.",
          "type": "string",
          "x-encrypted": true,
          "x-referenceable": true
        },
        "aws_imds_protocol_version": {
          "description": "Identifier to select the IMDS protocol version to use: `v1` or `v2`.",
          "type": "string",
          "default": "v1",
          "enum": [
            "v1",
            "v2"
          ]
        },
        "aws_key": {
          "description": "The AWS key credential to be used when invoking the function.",
          "type": "string",
          "x-encrypted": true,
          "x-referenceable": true
        },
        "aws_region": {
          "description": "A string representing a host name, such as example.com.",
          "type": "string"
        },
        "aws_role_session_name": {
          "description": "The identifier of the assumed role session.",
          "type": "string",
          "default": "kong"
        },
        "aws_secret": {
          "description": "The AWS secret credential to be used when invoking the function. ",
          "type": "string",
          "x-encrypted": true,
          "x-referenceable": true
        },
        "aws_sts_endpoint_url": {
          "description": "A string representing a URL, such as https://example.com/path/to/resource?q=search.",
          "type": "string"
        },
        "awsgateway_compatible": {
          "description": "An optional value that defines whether the plugin should wrap requests into the Amazon API gateway.",
          "type": "boolean",
          "default": false
        },
        "awsgateway_compatible_payload_version": {
          "description": "An optional value that defines which version will be used to generate the AWS API Gateway compatible payload. The default will be `1.0`.",
          "type": "string",
          "default": "1.0",
          "enum": [
            "1.0",
            "2.0"
          ]
        },
        "base64_encode_body": {
          "description": "An optional value that Base64-encodes the request body.",
          "type": "boolean",
          "default": true
        },
        "disable_https": {
          "type": "boolean",
          "default": false
        },
        "empty_arrays_mode": {
          "description": "An optional value that defines whether Kong should send empty arrays (returned by Lambda function) as `[]` arrays or `{}` objects in JSON responses. The value `legacy` means Kong will send empty arrays as `{}` objects in response",
          "type": "string",
          "default": "legacy",
          "enum": [
            "correct",
            "legacy"
          ]
        },
        "forward_request_body": {
          "description": "An optional value that defines whether the request body is sent in the request_body field of the JSON-encoded request. If the body arguments can be parsed, they are sent in the separate request_body_args field of the request. ",
          "type": "boolean",
          "default": false
        },
        "forward_request_headers": {
          "description": "An optional value that defines whether the original HTTP request headers are sent as a map in the request_headers field of the JSON-encoded request.",
          "type": "boolean",
          "default": false
        },
        "forward_request_method": {
          "description": "An optional value that defines whether the original HTTP request method verb is sent in the request_method field of the JSON-encoded request.",
          "type": "boolean",
          "default": false
        },
        "forward_request_uri": {
          "description": "An optional value that defines whether the original HTTP request URI is sent in the request_uri field of the JSON-encoded request.",
          "type": "boolean",
          "default": false
        },
        "function_name": {
          "description": "The AWS Lambda function to invoke. Both function name and function ARN (including partial) are supported.",
          "type": "string"
        },
        "host": {
          "description": "A string representing a host name, such as example.com.",
          "type": "string"
        },
        "invocation_type": {
          "description": "The InvocationType to use when invoking the function. Available types are RequestResponse, Event, DryRun.",
          "type": "string",
          "default": "RequestResponse",
          "enum": [
            "DryRun",
            "Event",
            "RequestResponse"
          ]
        },
        "is_proxy_integration": {
          "description": "An optional value that defines whether the response format to receive from the Lambda to this format.",
          "type": "boolean",
          "default": false
        },
        "keepalive": {
          "description": "An optional value in milliseconds that defines how long an idle connection lives before being closed.",
          "type": "number",
          "default": 60000
        },
        "log_type": {
          "description": "The LogType to use when invoking the function. By default, None and Tail are supported.",
          "type": "string",
          "default": "Tail",
          "enum": [
            "None",
            "Tail"
          ]
        },
        "port": {
          "description": "An integer representing a port number between 0 and 65535, inclusive.",
          "type": "integer",
          "default": 443,
          "maximum": 65535,
          "minimum": 0
        },
        "proxy_url": {
          "description": "A string representing a URL, such as https://example.com/path/to/resource?q=search.",
          "type": "string"
        },
        "qualifier": {
          "description": "The qualifier to use when invoking the function.",
          "type": "string"
        },
        "skip_large_bodies": {
          "description": "An optional value that defines whether Kong should send large bodies that are buffered to disk",
          "type": "boolean",
          "default": true
        },
        "ssl_verify": {
          "description": "Set to `true` to verify the TLS certificate when connecting to AWS services.",
          "type": "boolean",
          "default": true
        },
        "timeout": {
          "description": "An optional timeout in milliseconds when invoking the function.",
          "type": "number",
          "default": 60000
        },
        "unhandled_status": {
          "description": "The response status code to use (instead of the default 200, 202, or 204) in the case of an Unhandled Function Error.",
          "type": "integer",
          "maximum": 999,
          "minimum": 100
        }
      }
    },
    "consumer": {
      "description": "If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "name": {
      "const": "aws-lambda"
    },
    "protocols": {
      "description": "A set of strings representing HTTP protocols.",
      "type": "array",
      "items": {
        "enum": [
          "grpc",
          "grpcs",
          "http",
          "https"
        ],
        "type": "string"
      },
      "format": "set",
      "default": [
        "grpc",
        "grpcs",
        "http",
        "https"
      ]
    },
    "route": {
      "description": "If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    },
    "service": {
      "description": "If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}