Cors

The cross-origin resource sharing (CORS) settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL.

APIs.ioEngineeringPlatform

Properties

Name Type Description
AllowCredentials object
AllowHeaders object
AllowMethods object
AllowOrigins object
ExposeHeaders object
MaxAge object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-cors-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Cors",
  "title": "Cors",
  "type": "object",
  "properties": {
    "AllowCredentials": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AllowCredentials"
        },
        {
          "description": "Whether to allow cookies or other credentials in requests to your function URL. The default is <code>false</code>."
        }
      ]
    },
    "AllowHeaders": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HeadersList"
        },
        {
          "description": "The HTTP headers that origins can include in requests to your function URL. For example: <code>Date</code>, <code>Keep-Alive</code>, <code>X-Custom-Header</code>."
        }
      ]
    },
    "AllowMethods": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AllowMethodsList"
        },
        {
          "description": "The HTTP methods that are allowed when calling your function URL. For example: <code>GET</code>, <code>POST</code>, <code>DELETE</code>, or the wildcard character (<code>*</code>)."
        }
      ]
    },
    "AllowOrigins": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AllowOriginsList"
        },
        {
          "description": "<p>The origins that can access your function URL. You can list any number of specific origins, separated by a comma. For example: <code>https://www.example.com</code>, <code>http://localhost:60905</code>.</p> <p>Alternatively, you can grant access to all origins using the wildcard character (<code>*</code>).</p>"
        }
      ]
    },
    "ExposeHeaders": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HeadersList"
        },
        {
          "description": "The HTTP headers in your function response that you want to expose to origins that call your function URL. For example: <code>Date</code>, <code>Keep-Alive</code>, <code>X-Custom-Header</code>."
        }
      ]
    },
    "MaxAge": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxAge"
        },
        {
          "description": "The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to <code>0</code>, which means that the browser doesn't cache results."
        }
      ]
    }
  },
  "description": "The <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS\">cross-origin resource sharing (CORS)</a> settings for your Lambda function URL. Use CORS to grant access to your function URL from any origin. You can also use CORS to control access for specific HTTP headers and methods in requests to your function URL."
}