MongoDB C++ Driver  mongocxx-3.10.2
Public Member Functions | List of all members
mongocxx::v_noabi::options::rewrap_many_datakey Class Reference

Class representing options for a rewrap many datakey operation. More...

#include <rewrap_many_datakey.hpp>

Public Member Functions

rewrap_many_datakeyprovider (bsoncxx::v_noabi::string::view_or_value provider)
 Set the optional KMS provider use to encrypt the data keys. More...
 
bsoncxx::v_noabi::string::view_or_value provider () const
 Get the KMS provider. More...
 
rewrap_many_datakeymaster_key (bsoncxx::v_noabi::document::view_or_value master_key)
 Set the masterKey option. More...
 
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & master_key () const
 Get the masterKey option. More...
 

Detailed Description

Class representing options for a rewrap many datakey operation.

Member Function Documentation

◆ master_key() [1/2]

const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& mongocxx::v_noabi::options::rewrap_many_datakey::master_key ( ) const

Get the masterKey option.

The masterKey document MUST have the fields corresponding to the given provider as specified in masterKey. masterKey MUST NOT be given if it is not applicable for the given provider.

Returns
A reference to this object to facilitate method chaining.
See also
https://www.mongodb.com/docs/manual/core/csfle/reference/kms-providers/#std-label-csfle-reference-kms-providers-create-and-store

◆ master_key() [2/2]

rewrap_many_datakey& mongocxx::v_noabi::options::rewrap_many_datakey::master_key ( bsoncxx::v_noabi::document::view_or_value  master_key)

Set the masterKey option.

The masterKey document MUST have the fields corresponding to the given provider as specified in masterKey. masterKey MUST NOT be given if it is not applicable for the given provider.

Parameters
master_keyA document of the master key.
Returns
A reference to this object to facilitate method chaining.
See also
https://www.mongodb.com/docs/manual/core/csfle/reference/kms-providers/#std-label-csfle-reference-kms-providers-create-and-store

◆ provider() [1/2]

bsoncxx::v_noabi::string::view_or_value mongocxx::v_noabi::options::rewrap_many_datakey::provider ( ) const

Get the KMS provider.

A KMS provider (AWS KMS, Azure Key Vault, GCP KMS, the local provider, or KMIP) is used to decrypt data keys after fetching from the MongoDB Key Vault, and encrypt newly created data keys.

Returns
An optional string name of the provider.
See also
https://www.mongodb.com/docs/manual/core/csfle/reference/kms-providers/#std-label-csfle-reference-kms-providers

◆ provider() [2/2]

rewrap_many_datakey& mongocxx::v_noabi::options::rewrap_many_datakey::provider ( bsoncxx::v_noabi::string::view_or_value  provider)

Set the optional KMS provider use to encrypt the data keys.

Do not set to use the current KMS provider(s).

A KMS provider (AWS KMS, Azure Key Vault, GCP KMS, the local provider, or KMIP) is used to decrypt data keys after fetching from the MongoDB Key Vault, and encrypt newly created data keys.

Parameters
providerString name of the provider.
Returns
An optional document containing the TLS options.
See also
https://www.mongodb.com/docs/manual/core/csfle/reference/kms-providers/#std-label-csfle-reference-kms-providers

The documentation for this class was generated from the following file: