Sign in
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"
}

Changes

Changed in 3 of the 52 revisions of this API.911

  • 19e869275e281See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 96118a9cd7f49See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      response-property-became-nullable

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9ca62eba4eca1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog