Amazon X-Ray · Schema

EncryptionConfig

A configuration document that specifies encryption configuration settings.

Application PerformanceDebuggingDistributed TracingMonitoringObservability

Properties

Name Type Description
KeyId object
Status object
Type object
View JSON Schema on GitHub

JSON Schema

xray-encryption-config-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "KeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The ID of the KMS key used for encryption, if applicable."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionStatus"
        },
        {
          "description": "The encryption status. While the status is <code>UPDATING</code>, X-Ray may encrypt data with a combination of the new and old settings."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionType"
        },
        {
          "description": "The type of encryption. Set to <code>KMS</code> for encryption with KMS keys. Set to <code>NONE</code> for default encryption."
        }
      ]
    }
  },
  "description": "A configuration document that specifies encryption configuration settings.",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EncryptionConfig",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-encryption-config-schema.json"
}