Skip to content

Commit 44cde52

Browse files
Remove aws-specific language from KMS definition (#1744)
1 parent ce35696 commit 44cde52

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

source/client-side-encryption/client-side-encryption.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,13 @@ The type of backing KMS. Identified by the string: `aws`, `azure`, `gcp`, `kmip`
106106
An optional name to identify a KMS provider. Enables configuring multiple KMS providers with the same KMS provider type
107107
(e.g. `aws:name1` and `aws:name2` can refer to different AWS accounts).
108108

109-
**Customer Master Key (CMK)**
109+
**Master Key**
110110

111-
The underlying key AWS KMS uses to encrypt and decrypt. See
112-
[AWS Key Management Service Concepts](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys).
111+
The underlying key the KMS service uses to encrypt and decrypt. See
112+
[AWS KMS Concepts](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) for an AWS-specific
113+
example (other KMS providers work similarly).
114+
115+
The master key is also sometimes referred to as a Customer Master Key (CMK).
113116

114117
**schema**
115118

@@ -227,7 +230,7 @@ opts = ClientEncryptionOpts(kms_providers=kms, key_vault_namespace="db.datakeys"
227230
clientencryption = ClientEncryption(client, opts)
228231

229232
# Use a ClientEncryption to create new data keys.
230-
# The master key identifies the CMK on AWS KMS to use for encrypting the data key.
233+
# The master key identifies the KMS key on AWS KMS to use for encrypting the data key.
231234
master_key = open("./aws_masterkey.json", "r").read()
232235
opts = DataKeyOpts (master_key=master_key)
233236
created_key_id = clientencryption.create_data_key("aws", opts)
@@ -1095,7 +1098,7 @@ type "aws", the masterKey is required and has the following fields:
10951098
```typescript
10961099
{
10971100
region: String,
1098-
key: String, // The Amazon Resource Name (ARN) to the AWS customer master key (CMK).
1101+
key: String, // The Amazon Resource Name (ARN) to the AWS customer master key (KMS key).
10991102
endpoint: Optional<String> // An alternate host identifier to send KMS requests to. May include port number. Defaults to "kms.<region>.amazonaws.com"
11001103
}
11011104
```

0 commit comments

Comments
 (0)