Amazon CloudFront · JSON Structure

Cloudfront Cache Behavior Structure

CacheBehavior schema

Type: object Properties: 9 Required: 2

CloudFrontCDNContent DeliveryEdge

CacheBehavior is a JSON Structure definition published by Amazon CloudFront, describing 9 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

PathPattern TargetOriginId ViewerProtocolPolicy AllowedMethods CachePolicyId OriginRequestPolicyId Compress FunctionAssociations LambdaFunctionAssociations

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cloudfront/refs/heads/main/json-structure/cloudfront-cache-behavior-structure.json",
  "name": "CacheBehavior",
  "description": "CacheBehavior schema",
  "type": "object",
  "properties": {
    "PathPattern": {
      "type": "string",
      "description": "The pattern that specifies which requests to apply the behavior to. Not required for the default cache behavior."
    },
    "TargetOriginId": {
      "type": "string",
      "description": "The ID of the origin that you want CloudFront to route requests to."
    },
    "ViewerProtocolPolicy": {
      "type": "string",
      "enum": [
        "allow-all",
        "https-only",
        "redirect-to-https"
      ],
      "description": "The protocol that viewers can use to access the files in the origin."
    },
    "AllowedMethods": {
      "type": "object",
      "properties": {
        "Quantity": {
          "type": "int32"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "GET",
              "HEAD",
              "POST",
              "PUT",
              "PATCH",
              "OPTIONS",
              "DELETE"
            ]
          }
        }
      }
    },
    "CachePolicyId": {
      "type": "string",
      "description": "The unique identifier of the cache policy."
    },
    "OriginRequestPolicyId": {
      "type": "string",
      "description": "The unique identifier of the origin request policy."
    },
    "Compress": {
      "type": "boolean",
      "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior."
    },
    "FunctionAssociations": {
      "type": "object",
      "properties": {
        "Quantity": {
          "type": "int32"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "FunctionARN": {
                "type": "string"
              },
              "EventType": {
                "type": "string",
                "enum": [
                  "viewer-request",
                  "viewer-response"
                ]
              }
            }
          }
        }
      }
    },
    "LambdaFunctionAssociations": {
      "type": "object",
      "properties": {
        "Quantity": {
          "type": "int32"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "LambdaFunctionARN": {
                "type": "string"
              },
              "EventType": {
                "type": "string",
                "enum": [
                  "viewer-request",
                  "viewer-response",
                  "origin-request",
                  "origin-response"
                ]
              }
            }
          }
        }
      }
    }
  },
  "required": [
    "ViewerProtocolPolicy",
    "TargetOriginId"
  ]
}