focal (3) mongoc_client_encryption_datakey_opts_set_masterkey.3.gz

Provided by: libmongoc-doc_1.16.1-1build2_all bug

NAME
       mongoc_client_encryption_datakey_opts_set_masterkey                                                     -
       mongoc_client_encryption_datakey_opts_set_masterkey()


SYNOPSIS
          void
          mongoc_client_encryption_datakey_opts_set_masterkey (
             mongoc_client_encryption_datakey_opts_t *opts, const bson_t *masterkey);

       Identifies the masterkey for the Key Management Service (KMS) provider used to encrypt a new data key.


PARAMETERS
       • opts: A mongoc_client_encryption_datakey_opts_t

       • masterkey: A bson_t document describing the KMS provider specific masterkey.


DESCRIPTION
       Setting the masterkey is required if using AWS KMS, and masterkey must have the form:

          {
             region: <string>, // Required.
             key: <string>, // Required. The Amazon Resource Name (ARN) to the AWS customer master key (CMK).
             endpoint: <string> // Optional. An alternate host identifier to send KMS requests to. May include port number.
          }

       The value of  "endpoint"  is  a  host  name  with  optional  port  number  separated  by  a  colon.  E.g.
       "kms.us-east-1.amazonaws.com" or "kms.us-east-1.amazonaws.com:443"

       This  function is only applicable for the "aws" KMS provider. It is not applicable for creating data keys
       with the "local" KMS provider (as configured in mongoc_client_encryption_opts_set_kms_providers()).


AUTHOR
       MongoDB, Inc


       2017-present, MongoDB, Inc

1.16.1                                            Mar 03, MONGOC_CLIENT_ENCRYPTION_DATAKEY_OPTS_SET_MASTERKEY(3)