FunctionUrlConfig

Details about a Lambda function URL.

APIs.ioEngineeringPlatform

Properties

Name Type Description
FunctionUrl object
FunctionArn object
CreationTime object
LastModifiedTime object
Cors object
AuthType object
InvokeMode object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-functionurlconfig-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FunctionUrlConfig",
  "title": "FunctionUrlConfig",
  "type": "object",
  "required": [
    "FunctionUrl",
    "FunctionArn",
    "CreationTime",
    "LastModifiedTime",
    "AuthType"
  ],
  "properties": {
    "FunctionUrl": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FunctionUrl"
        },
        {
          "description": "The HTTP URL endpoint for your function."
        }
      ]
    },
    "FunctionArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FunctionArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of your function."
        }
      ]
    },
    "CreationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "When the function URL was created, in <a href=\"https://www.w3.org/TR/NOTE-datetime\">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD)."
        }
      ]
    },
    "LastModifiedTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "When the function URL configuration was last updated, in <a href=\"https://www.w3.org/TR/NOTE-datetime\">ISO-8601 format</a> (YYYY-MM-DDThh:mm:ss.sTZD)."
        }
      ]
    },
    "Cors": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Cors"
        },
        {
          "description": "The <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS\">cross-origin resource sharing (CORS)</a> settings for your function URL."
        }
      ]
    },
    "AuthType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FunctionUrlAuthType"
        },
        {
          "description": "The type of authentication that your function URL uses. Set to <code>AWS_IAM</code> if you want to restrict access to authenticated users only. Set to <code>NONE</code> if you want to bypass IAM authentication to create a public endpoint. For more information, see <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html\">Security and auth model for Lambda function URLs</a>."
        }
      ]
    },
    "InvokeMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InvokeMode"
        },
        {
          "description": "<p>Use one of the following options:</p> <ul> <li> <p> <code>BUFFERED</code> \u00e2\u20ac\u201c This is the default option. Lambda invokes your function using the <code>Invoke</code> API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.</p> </li> <li> <p> <code>RESPONSE_STREAM</code> \u00e2\u20ac\u201c Your function streams payload results as they become available. Lambda invokes your function using the <code>InvokeWithResponseStream</code> API operation. The maximum response payload size is 20 MB, however, you can <a href=\"https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html\">request a quota increase</a>.</p> </li> </ul>"
        }
      ]
    }
  },
  "description": "Details about a Lambda function URL."
}