@@ -106,10 +106,13 @@ The type of backing KMS. Identified by the string: `aws`, `azure`, `gcp`, `kmip`
106
106
An optional name to identify a KMS provider. Enables configuring multiple KMS providers with the same KMS provider type
107
107
(e.g. ` aws:name1 ` and ` aws:name2 ` can refer to different AWS accounts).
108
108
109
- ** Customer Master Key (CMK) **
109
+ ** Master Key**
110
110
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).
113
116
114
117
** schema**
115
118
@@ -227,7 +230,7 @@ opts = ClientEncryptionOpts(kms_providers=kms, key_vault_namespace="db.datakeys"
227
230
clientencryption = ClientEncryption(client, opts)
228
231
229
232
# 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.
231
234
master_key = open (" ./aws_masterkey.json" , " r" ).read()
232
235
opts = DataKeyOpts (master_key = master_key)
233
236
created_key_id = clientencryption.create_data_key(" aws" , opts)
@@ -1095,7 +1098,7 @@ type "aws", the masterKey is required and has the following fields:
1095
1098
``` typescript
1096
1099
{
1097
1100
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 ).
1099
1102
endpoint : Optional < String > // An alternate host identifier to send KMS requests to. May include port number. Defaults to "kms.<region>.amazonaws.com"
1100
1103
}
1101
1104
```
0 commit comments