クラス: Mongo::Crypt::KMS::AWS: MasterKeyDocument Private

継承:
オブジェクト
  • オブジェクト
すべて表示
次のことが含まれます。
検証
定義:
lib/mongo/crypt/KMS/ Amazon Web Services/ Master_document.rb

Overview

このクラスは、プライベート API の一部です。 このクラスは将来削除または変更される可能性があるため、可能な限り使用しないでください。

Amazon Web Services KMSマスター キー ドキュメント オブジェクトには、 KMSマスター キー パラメーターが含まれています。

定数の概要の削減

FORMAT_HINT =

この定数は、プライベート API の一部です。 この定数は将来削除または変更される可能性があるため、可能な限り使用しないでください。 

" Amazon Web Servicesキー ドキュメントは次の形式である必要があります: +
。{ region: 'REGION', key: 'KEY' }。

インスタンス属性の概要を折りたたむ

インスタンス メソッドの概要を折りたたむ

検証に含まれるメソッド

#validate_param, validate_tls_options

コンストラクターの詳細

#初期化（opts） = マスターキードキュメント

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

パラメーター ハッシュからマスター キー ドキュメント オブジェクトを作成します。

パラメーター:

  • ops （ハッシュ） —

    Amazon Web Services KMSプロバイダーのマスター キー オプションを含むハッシュ。

オプション ハッシュ（ opts ）:

  • :region （ string ） —

    Amazon Web Servicesリージョン。

  • :key （ string ） —

    Amazon Web Services KMSキー。

  • : エンドポイント （ string | nil ） —

    Amazon Web Services KMSエンドポイント（任意）。

次の値が発生します。

  • (ArgumentError) —

    必須 オプションが欠落しているか正しくない場合。

[ソースを表示]

49
50
51
52
53
54
55
56
57
58
 
# ファイル 'lib/mongo/crypt/KMS/ Amazon Web Services/host_document.rb' の場合は、49 行

デフォルト 初期化(ops)
  ただし、 ops.is_a?(ハッシュ)
    発生 ArgumentError.新着情報(
      'キー ドキュメント オプションには、 ハッシュ値 を持つ という名前のキーが含まれている必要があります。
    )
  end
  @region = validate_param(:region, ops, FORMAT_HINT)
  @key = validate_param(:key, ops, FORMAT_HINT)
  @endpoint = validate_param(: エンドポイント, ops, FORMAT_HINT, 必須: false)
end

インスタンス属性の詳細

#エンドポイント= string | nil （読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

Amazon Web Services KMSエンドポイントを返します。

次の値を返します。

  • ( string | nil ) —

    Amazon Web Services KMSエンドポイント。


35
36
37
 
# ファイル 'lib/mongo/crypt/KMS/ Amazon Web Services/host_document.rb' の場合は、35 行

デフォルト エンドポイント
  @endpoint
end

#キーとstring （読み取り専用）

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

Amazon Web Services KMSキーを返します。

次の値を返します。

  • ( string ) —

    Amazon Web Services KMSキー。


32
33
34
 
# ファイル 'lib/mongo/crypt/KMS/ Amazon Web Services/host_document.rb' の場合は、32 行

デフォルト キー
  @key
end

# region = string (readonly)

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

Amazon Web Servicesのリージョンを返します。

次の値を返します。

  • ( string ) —

    Amazon Web Servicesリージョン。


29
30
31
 
# ファイル 'lib/mongo/crypt/KMS/ Amazon Web Services/host_document.rb' の場合は、29 行

デフォルト リージョン
  @region
end

インスタンス メソッドの詳細

#to_document ⇒ BSON::Document

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

マスターキー ドキュメント オブジェクトを libmongocrypt 形式の BSON ドキュメントに変換します。

次の値を返します。

  • （ BSON::Document ） —

    libmongocrypt 形式のAmazon Web Services KMSマスターキー ドキュメント。

[ソースを表示]

63
64
65
66
67
68
69
70
71
72
73
 
# ファイル 'lib/mongo/crypt/KMS/ Amazon Web Services/host_document.rb' の場合は、63 行

デフォルト to_document
  BSON::ドキュメント.新着情報({
    プロバイダー: 'aws',
    リージョン: リージョン,
    キー: キー,
  }).タップ 行う |bson|
    ただし、 エンドポイント.nil?
      bson.update({ エンドポイント: エンドポイント })
    end
  end
end