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

継承:
オブジェクト
  • オブジェクト
すべて表示
次による拡張機能。
転送可能
次のことが含まれます。
検証
定義:
lib/mongo/crypt/KMS/ Amazon Web Services/credentials.rb

Overview

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

Amazon Web Services KMS認証情報オブジェクトには、 Amazon Web Services KMSプロバイダーを使用するための認証情報が含まれています。

定数の概要の削減

FORMAT_HINT =

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

AWS KMS プロバイダー オプションは : の形式である必要があります。 +
。{access_key_id: "YOUR-ACCESS-KEY-ID", secret_access_key: "SECRET-ACCESS-KEY" }。

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

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

検証に含まれるメソッド

#validate_param, validate_tls_options

コンストラクターの詳細

#初期化（opts） =認証情報

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

パラメーター ハッシュからAmazon Web Services KMS認証情報オブジェクトを作成します。

パラメーター:

  • ops （ハッシュ） —

    Amazon Web Services KMSプロバイダーの認証情報を含むハッシュ

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

  • :access_key_id （ string ） —

    Amazon Web ServicesアクセスキーID 。

  • :secret_access_key （ string ） —

    Amazon Web Servicesシークレット アクセス キー。

  • :session_token （ string | nil ） —

    Amazon Web Servicesセッション トークン（任意）。

次の値が発生します。

  • (ArgumentError) —

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



53
54
55
56
57
58
59
60
 
# ファイル 'lib/mongo/crypt/KMS/ Amazon Web Services/credentials.rb' の場合53

デフォルト 初期化(ops)
  @opts = ops
  return 場合 空の場合

  @access_key_id = validate_param(:access_key_id, ops, FORMAT_HINT)
  @secret_access_key = validate_param(:secret_access_key, ops, FORMAT_HINT)
  @session_token = validate_param(:session_token, ops, FORMAT_HINT, 必須: false)
end

インスタンス属性の詳細

# access_key_id = string （読み取り専用）

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

Amazon Web Servicesのアクセスキーを返します。

次の値を返します。

  • ( string ) —

    Amazon Web Servicesアクセスキー。



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

デフォルト access_key_id
  @access_key_id
end

# secret_access_key = string （読み取り専用）

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

Amazon Web Servicesシークレット アクセス キーを返します。

次の値を返します。

  • ( string ) —

    Amazon Web Servicesシークレット アクセス キー。



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

デフォルト secret_access_key
  @secret_access_key
end

#session_token 詳しくは、 string | nil （読み取り専用）

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

Amazon Web Servicesセッション トークンを返します。

次の値を返します。

  • ( string | nil ) —

    AWS session token.



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

デフォルト session_token
  @session_token
end

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

#to_document ⇒ BSON::Document

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

認証情報オブジェクトを libmongocrypt 形式の BSON ドキュメントに変換します。

次の値を返します。

  • （ BSON::Document ） —

    libmongocrypt 形式のAmazon Web Services KMS認証情報。



65
66
67
68
69
70
71
72
73
74
 
# ファイル 'lib/mongo/crypt/KMS/ Amazon Web Services/credentials.rb' の場合65

デフォルト to_document
  return BSON::ドキュメント.新着情報 場合 空の場合

  BSON::ドキュメント.新着情報({
                       accessKeyId: access_key_id,
                       secretAccessKey: secret_access_key,
                     }).タップ 行う |bson|
    bson.update({ sessionToken: session_token }) ただし、 session_token.nil?
  end
end