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 if using AWS KMS, and masterkey  must
25       have the form:
26
27          {
28             region: <string>, // Required.
29             key: <string>, // Required. The Amazon Resource Name (ARN) to the AWS customer master key (CMK).
30             endpoint: <string> // Optional. An alternate host identifier to send KMS requests to. May include port number.
31          }
32
33       The  value of "endpoint" is a host name with optional port number sepa‐
34       rated   by   a    colon.    E.g.    "kms.us-east-1.amazonaws.com"    or
35       "kms.us-east-1.amazonaws.com:443"
36
37       This  function is only applicable for the "aws" KMS provider. It is not
38       applicable for creating data keys with the  "local"  KMS  provider  (as
39       configured in mongoc_client_encryption_opts_set_kms_providers()).
40

AUTHOR

42       MongoDB, Inc
43

45       2017-present, MongoDB, Inc
46
47
48
49
501.17.6                  MONGOC_CLJIuEnNT0_3E,NC2R0Y2P1TION_DATAKEY_OPTS_SET_MASTERKEY(3)
Impressum