AWS App Mesh · Schema

FileAccessLog

An object that represents an access log file.

DeprecatedEnvoyMicroservicesNetworkingService Mesh

Properties

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

JSON Schema

app-mesh-file-access-log-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "format": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoggingFormat"
        },
        {
          "description": "The specified format for the logs. The format is either <code>json_format</code> or <code>text_format</code>."
        }
      ]
    },
    "path": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FilePath"
        },
        {
          "description": "<p>The file path to write access logs to. You can use <code>/dev/stdout</code> to send access logs to standard out and configure your Envoy container to use a log driver, such as <code>awslogs</code>, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.</p> <pre><code> &lt;note&gt; &lt;p&gt;The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.&lt;/p&gt; &lt;/note&gt; </code></pre>"
        }
      ]
    }
  },
  "required": [
    "path"
  ],
  "description": "An object that represents an access log file.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-app-mesh/refs/heads/main/json-schema/app-mesh-file-access-log-schema.json",
  "title": "FileAccessLog"
}