Skip to main content
Version: 8.7

Key state behavior

Learn how Camunda 8 SaaS responds when your external Amazon KMS encryption key (BYOK) becomes unavailable during cluster startup or runtime.

This page applies only to external customer-managed keys (AWS KMS). For encryption fundamentals, see the encryption overview.

warning

If your external encryption key is disabled, deleted, or its permissions are revoked, your cluster becomes inaccessible and may enter a frozen state. Camunda cannot recover encrypted data if the key is permanently deleted.

Key state summary

The table below provides a high-level overview of how different KMS key states affect cluster startup, operation, and data availability.

Key stateCluster startupCluster runtimeData accessible?Recovery possible?
Enabled✔ Starts normally✔ Operates normallyYesNot needed
Disabled❌ Cannot start❌ Freezes: no reads/writes, operations hangNo✔ Re-enable key
Scheduled for deletion❌ Cannot start❌ Same as disabledNo✔ Cancel deletion + re-enable
Permanently deleted❌ Cannot start❌ Cluster remains non-functional permanentlyNo❌ No — encrypted data lost
Incorrect key policy❌ Cannot start❌ Behaves like disabled keyNo✔ Fix policy

What happens when a key becomes unavailable?

When a cluster loses access to its KMS key:

  • All encryption/decryption requests fail immediately.
  • Zeebe, Elasticsearch, and backup operations freeze.
  • Console may still show the cluster as Healthy, even though no work can proceed.
  • Within ~15 minutes, the Encryption at rest panel displays:

    External encryption key is not ready

Timeline of effects

  1. Immediate (0–1s): Key becomes inaccessible.
  2. Seconds: Storage reads/writes hang.
  3. Backup jobs: Become stuck “In progress” indefinitely.
  4. Suspend/Resume: Requests appear accepted but never execute.
  5. Console status: May incorrectly continue to show “Healthy.”
  6. After re-enabling: Automatic recovery occurs, but timing depends on reconciliation and exponential backoff.

Component-level impact

Component/featureRequires key forBehavior when key unavailable
Zeebe brokersState storage (encrypted disks)Execution freezes; no read/write activity
ElasticsearchPersistent disk encryptionIndexing and queries freeze
BackupsEncrypting/decrypting snapshotsBackup requests hang forever
Restore operationsDecrypting snapshotsRestore cannot proceed
Document storageEncrypting stored filesDocument reads/writes freeze
Suspend / resumeChanging cluster stateRequest is logged but not executed

Behavior by key lifecycle state

Disabled key

  • Cluster cannot start.
  • If cluster was running:
    • All operations freeze.
    • Suspend/resume does not complete.
    • Backup operations get stuck.
  • Console eventually shows: External encryption key is not ready

Recovery:
Re-enable the KMS key. Cluster resumes automatically, but recovery time increases the longer the key was disabled.

Key scheduled for deletion

Scheduling deletion automatically disables the key.

Behavior is identical to a disabled key.

Recovery:
Cancel deletion → Re-enable the key.

Permanently deleted key

Once the AWS deletion waiting period passes:

  • The key is irrecoverable.
  • The cluster becomes permanently unusable.
  • No encrypted data can be recovered.

Recovery:
Not possible. Create a new cluster.

Incorrect or missing key policy

If the KMS policy does not grant Camunda's AWS Role the required permissions:

  • Cluster cannot start or becomes frozen.
  • Behavior mirrors a disabled key.

Recovery:
Update the KMS key policy using the Tenant Role ARN displayed in Console.

Error handling and user-visible messages

Currently, Camunda displays a single unified message:

External encryption key is not ready

More granular messaging is planned for future iterations.

Operator responsibilities and best practices

Customer responsibilities (BYOK model)

  • Maintain and monitor the key lifecycle in AWS.
  • Monitor for disable/delete events (CloudWatch & EventBridge).
  • Ensure policies remain correct.
  • Understand that deleting or disabling the key freezes the cluster.

Activate:

  • CloudWatch alerts for key disabled, scheduled deletion, access denied
  • EventBridge for policy changes
  • CloudTrail for Encrypt/Decrypt failures and audit logs