1MONGOC_CLIENT_ENCRYPTION_MDOANTGAOKCE_YC_LOIPETlNSiT_b_SmEEoNTnC_gRMoYAcPSTTIEORNK_EDYA(T3A)KEY_OPTS_SET_MASTERKEY(3)
2
3
4

NAME

6       mongoc_client_encryption_datakey_opts_set_masterkey - mongoc_client_en‐
7       cryption_datakey_opts_set_masterkey()
8

SYNOPSIS

10          void
11          mongoc_client_encryption_datakey_opts_set_masterkey (
12             mongoc_client_encryption_datakey_opts_t *opts, const bson_t *masterkey);
13
14       Identifies the masterkey for the Key Management Service (KMS)  provider
15       used to encrypt a new data key.
16

PARAMETERS

18       • opts: A mongoc_client_encryption_datakey_opts_t
19
20       • masterkey:  A  bson_t  document  describing the KMS provider specific
21         masterkey.
22

DESCRIPTION

24       Setting the masterkey is required when creating a data key with the KMS
25       providers: aws, azure, gcp, and kmip.
26
27       Setting the masterkey is prohibited with the KMS provider local.
28
29       The format of masterkey for "aws" is as follows:
30
31          {
32             region: String,
33             key: String, /* The Amazon Resource Name (ARN) to the AWS customer master key (CMK). */
34             endpoint: Optional<String> /* An alternate host identifier to send KMS requests to. May include port number. Defaults to "kms.<region>.amazonaws.com" */
35          }
36
37       The format of masterkey for "azure" is as follows:
38
39          {
40             keyVaultEndpoint: String, /* Host with optional port. Example: "example.vault.azure.net". */
41             keyName: String,
42             keyVersion: Optional<String> /* A specific version of the named key, defaults to using the key's primary version. */
43          }
44
45       The format of masterkey for "gcp" is as follows:
46
47          {
48             projectId: String,
49             location: String,
50             keyRing: String,
51             keyName: String,
52             keyVersion: Optional<String>, /* A specific version of the named key, defaults to using the key's primary version. */
53             endpoint: Optional<String> /* Host with optional port. Defaults to "cloudkms.googleapis.com". */
54          }
55
56       The format of masterkey for "kmip" is as follows:
57
58          {
59             keyId: Optional<String>,
60             endpoint: Optional<String> /* Host with optional port. */
61          }
62

AUTHOR

64       MongoDB, Inc
65

67       2017-present, MongoDB, Inc
68
69
70
71
721.20.0                  MONGOC_CLNIoEvNT1_8E,NC2R0Y2P1TION_DATAKEY_OPTS_SET_MASTERKEY(3)
Impressum