AccessLogSettings

Access log settings, including the access log format and access log destination ARN.

APIs.ioEngineeringPlatform

Properties

Name Type Description
format object
destinationArn object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-accesslogsettings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccessLogSettings",
  "title": "AccessLogSettings",
  "type": "object",
  "properties": {
    "format": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "A single line format of the access logs of data, as specified by selected $context variables. The format must include at least <code>$context.requestId</code>."
        }
      ]
    },
    "destinationArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with <code>amazon-apigateway-</code>."
        }
      ]
    }
  },
  "description": "Access log settings, including the access log format and access log destination ARN."
}