v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB
CMEK

Create or replace a CMEK

Create or replace a customer managed encryption key.

put/v1/cmeks/{cmekId}

Request body

key_arnstring required

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.

namestring required

The name of the CMEK. We recommend you match the key's name used in KMS.

descriptionstring

An optional description of the CMEK.

Example request

{
  "key_arn": "arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012",
  "name": "My KMS Key",
  "description": "My Key Description"
}

Response

A CMEK

idstring required
key_arnstring required

The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.

namestring required

The name of the CMEK. We recommend you match the key's name used in KMS.

descriptionstring

An optional description of the CMEK.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "key_arn": "arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012",
  "name": "My KMS Key",
  "description": "My Key Description",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}