Skip to content

Commit cfc3668

Browse files
authored
CXX-2813 document KMIP "delegated" option (#1278)
* use `///` instead of `//` * use markdown code block * fix multi-line comments
1 parent 7fb8c84 commit cfc3668

File tree

1 file changed

+19
-8
lines changed
  • src/mongocxx/include/mongocxx/v_noabi/mongocxx/options

1 file changed

+19
-8
lines changed

src/mongocxx/include/mongocxx/v_noabi/mongocxx/options/data_key.hpp

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,43 +39,54 @@ class data_key {
3939
///
4040
/// If the KMS provider is "aws" the masterKey is required and has the following fields:
4141
///
42+
/// ```
4243
/// {
4344
/// region: String,
4445
/// key: String, // The Amazon Resource Name (ARN) to the AWS customer master key (CMK).
4546
/// endpoint: Optional<String> // An alternate host identifier to send KMS requests to. May
46-
/// include port number. Defaults to "kms.<region>.amazonaws.com"
47+
/// // include port number. Defaults to
48+
/// // "kms.<region>.amazonaws.com"
4749
/// }
50+
/// ```
4851
///
4952
/// If the KMS provider is "azure" the masterKey is required and has the following fields:
5053
///
54+
/// ```
5155
/// {
5256
/// keyVaultEndpoint: String, // Host with optional port. Example: "example.vault.azure.net".
5357
/// keyName: String,
5458
/// keyVersion: Optional<String> // A specific version of the named key, defaults to using
55-
/// the key's primary version.
59+
/// // the key's primary version.
5660
/// }
61+
/// ```
5762
///
5863
/// If the KMS provider is "gcp" the masterKey is required and has the following fields:
5964
///
65+
/// ```
6066
/// {
6167
/// projectId: String,
6268
/// location: String,
6369
/// keyRing: String,
6470
/// keyName: String,
6571
/// keyVersion: Optional<String>, // A specific version of the named key, defaults to using
66-
/// the key's primary version.
72+
/// // the key's primary version.
6773
/// endpoint: Optional<String> // Host with optional port. Defaults to
68-
/// "cloudkms.googleapis.com".
74+
/// // "cloudkms.googleapis.com".
6975
/// }
76+
/// ```
7077
///
7178
/// If the KMS provider is "kmip" the masterKey is required and has the following fields:
7279
///
80+
/// ```
7381
/// {
74-
// keyId: Optional<String>, // keyId is the KMIP Unique Identifier to a 96 byte KMIP Secret
75-
// // Data managed object.If keyId is omitted, the driver creates a
76-
// // random 96 byte KMIP Secret Data managed object.
77-
// endpoint: Optional<String> // Host with optional port.
82+
/// keyId: Optional<String>, // keyId is the KMIP Unique Identifier to a 96 byte KMIP Secret
83+
/// // Data managed object.If keyId is omitted, the driver creates
84+
/// // a random 96 byte KMIP Secret Data managed object.
85+
/// endpoint: Optional<String>, // Host with optional port.
86+
/// delegated: Optional<Boolean> // If true, this key should be decrypted by the KMIP
87+
/// // server.
7888
/// }
89+
/// ```
7990
///
8091
/// If the KMS provider is "local" the masterKey is not applicable.
8192
///

0 commit comments

Comments
 (0)