Amazon X-Ray · Schema

PutEncryptionConfigRequest

PutEncryptionConfigRequest schema from Amazon X-Ray API

Application PerformanceDebuggingDistributed TracingMonitoringObservability

Properties

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

JSON Schema

xray-put-encryption-config-request-schema.json Raw ↑
{
  "type": "object",
  "required": [
    "Type"
  ],
  "title": "PutEncryptionConfigRequest",
  "properties": {
    "KeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionKeyId"
        },
        {
          "description": "<p>An Amazon Web Services KMS key in one of the following formats:</p> <ul> <li> <p> <b>Alias</b> - The name of the key. For example, <code>alias/MyKey</code>.</p> </li> <li> <p> <b>Key ID</b> - The KMS key ID of the key. For example, <code>ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Amazon Web Services X-Ray does not support asymmetric KMS keys.</p> </li> <li> <p> <b>ARN</b> - The full Amazon Resource Name of the key ID or alias. For example, <code>arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456</code>. Use this format to specify a key in a different account.</p> </li> </ul> <p>Omit this key if you set <code>Type</code> to <code>NONE</code>.</p>"
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncryptionType"
        },
        {
          "description": "The type of encryption. Set to <code>KMS</code> to use your own key for encryption. Set to <code>NONE</code> for default encryption."
        }
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-put-encryption-config-request-schema.json",
  "description": "PutEncryptionConfigRequest schema from Amazon X-Ray API"
}