MasterKeyDocument — Documentation by YARD 0.9.37 (original) (raw)
Class: Mongo::Crypt::KMS::AWS::MasterKeyDocumentPrivate
Inherits:
Object
- Object
- Mongo::Crypt::KMS::AWS::MasterKeyDocument show all
Includes:
Defined in:
lib/mongo/crypt/kms/aws/master_document.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
AWS KMS master key document object contains KMS master key parameters.
Constant Summarycollapse
FORMAT_HINT =
This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.
"AWS key document must be in the format: " + "{ region: 'REGION', key: 'KEY' }"
Instance Attribute Summary collapse
- #endpoint ⇒ String | nil readonly private
AWS KMS endpoint. - #key ⇒ String readonly private
AWS KMS key. - #region ⇒ String readonly private
AWS region.
Instance Method Summarycollapse
- #initialize(opts) ⇒ MasterKeyDocument constructor private
Creates a master key document object form a parameters hash. - #to_document ⇒ BSON::Document private
Convert master key document object to a BSON document in libmongocrypt format.
Methods included from Validations
#validate_param, validate_tls_options
Constructor Details
#initialize(opts) ⇒ MasterKeyDocument
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Creates a master key document object form a parameters hash.
| 49 50 51 52 53 54 55 56 57 58 | # File 'lib/mongo/crypt/kms/aws/master_document.rb', line 49 def initialize(opts) unless opts.is_a?(Hash) raise ArgumentError.new( 'Key document options must contain a key named :master_key with a Hash value' ) end @region = validate_param(:region, opts, FORMAT_HINT) @key = validate_param(:key, opts, FORMAT_HINT) @endpoint = validate_param(:endpoint, opts, FORMAT_HINT, required: false) end |
|---|
Instance Attribute Details
#endpoint ⇒ String | nil
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns AWS KMS endpoint.
| 35 36 37 | # File 'lib/mongo/crypt/kms/aws/master_document.rb', line 35 def endpoint @endpoint end |
|---|
#key ⇒ String
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns AWS KMS key.
| 32 33 34 | # File 'lib/mongo/crypt/kms/aws/master_document.rb', line 32 def key @key end |
|---|
#region ⇒ String
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns AWS region.
| 29 30 31 | # File 'lib/mongo/crypt/kms/aws/master_document.rb', line 29 def region @region end |
|---|
Instance Method Details
#to_document ⇒ BSON::Document
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Convert master key document object to a BSON document in libmongocrypt format.
| 63 64 65 66 67 68 69 70 71 72 73 | # File 'lib/mongo/crypt/kms/aws/master_document.rb', line 63 def to_document BSON::Document.new({ provider: 'aws', region: region, key: key, }).tap do |bson| unless endpoint.nil? bson.update({ endpoint: endpoint }) end end end | | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |