Amazon MQ · Schema

EncryptionOptions

Does not apply to RabbitMQ brokers.

Encryption options for the broker.

BroadcastingMedia ProcessingMedia

Properties

Name Type Description
KmsKeyId object
UseAwsOwnedKey object
View JSON Schema on GitHub

JSON Schema

mq-api-encryption-options-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mq/refs/heads/main/json-schema/mq-api-encryption-options-schema.json",
  "title": "EncryptionOptions",
  "description": "<important><p>Does not apply to RabbitMQ brokers.</p></important> <p>Encryption options for the broker.</p>",
  "type": "object",
  "properties": {
    "KmsKeyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "kmsKeyId"
          },
          "description": "The customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data."
        }
      ]
    },
    "UseAwsOwnedKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "xml": {
            "name": "useAwsOwnedKey"
          },
          "description": "Enables the use of an AWS owned CMK using AWS Key Management Service (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers."
        }
      ]
    }
  },
  "required": [
    "UseAwsOwnedKey"
  ]
}