类：Mongo::Crypt::KMS::AWS::Credentials Private

继承：
对象
  • 对象
显示全部
扩展方式：
可转发
包括：
验证
定义于：
build/Ruby-driver-v2.19/lib/ mongo /crypt/ KMS / Amazon Web Services /credentials.rb

Overview

此类是私有 API 的一部分。 应尽可能避免使用此类，因为它将来可能会被删除或更改。

Amazon Web Services KMS凭证对象包含使用Amazon Web Services KMS提供程序的凭证。

常量摘要折叠

FORMAT_HINT =

此常量是私有 API 的一部分。 应尽可能避免使用此常量，因为它将来可能会被删除或更改。 

" Amazon Web Services KMS提供程序选项必须采用以下格式： " +
"{ access_key_id: 'YOUR-ACCESS-KEY-ID', secret_access_key: 'SECRET-ACCESS-KEY' }"

实例属性摘要折叠

实例方法摘要折叠

验证中包含的方法

#validate_param , validate_tls_options

构造函数详情

#initialize (opts) ⇒档案

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

从参数哈希中创建Amazon Web Services KMS凭证对象。

参数：

  • opts (哈希) —

    包含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 ) —

    如果必需的选项丢失或格式不正确。



55
56
57
58
59
60
61
62
 
# File 'build/Ruby-driver-v2.19/lib/ mongo /crypt/ KMS / Amazon Web Services /credentials.rb', 第55行

def 初始化(opts)
  @opts = opts
  除非 空？
    @access_key_id = validate_param(:access_key_id, opts, FORMAT_HINT)
    @secret_access_key = validate_param(:secret_access_key, opts, FORMAT_HINT)
    @session_token = validate_param(:session_token, opts, FORMAT_HINT, 必需： false)
  end
end

实例属性详细信息

# access_key_id ⇒ string （只读）

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

返回Amazon Web Services访问密钥。

返回：

  • ( string ) —

    Amazon Web Services访问密钥。



31
32
33
 
# File 'build/Ruby-driver-v2.19/lib/ mongo /crypt/ KMS / Amazon Web Services /credentials.rb', 第31行

def access_key_id
  @access_key_id
end

# secret_access_key ⇒ string （只读）

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

返回Amazon Web Services秘密访问密钥。

返回：

  • ( string ) —

    Amazon Web Services秘密访问密钥。



34
35
36
 
# File 'build/Ruby-driver-v2.19/lib/ mongo /crypt/ KMS / Amazon Web Services /credentials.rb', 第34行

def secret_access_key
  @secret_access_key
end

# session_token ⇒ string | nil （只读）

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

返回Amazon Web Services会话令牌。

返回：

  • ( string | nil ) —

    Amazon Web Services会话令牌。



37
38
39
 
# File 'build/Ruby-driver-v2.19/lib/ mongo /crypt/ KMS / Amazon Web Services /credentials.rb', 第37行

def session_token
  @session_token
end

实例方法详细信息

# to_document ⇒ BSON::Document

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

将凭证对象转换为 libmongocrypt 格式的BSON文档。

返回：

  • ( BSON::Document ) —

    libmongocrypt 格式的Amazon Web Services KMS凭证。



67
68
69
70
71
72
73
74
75
76
77
 
# File 'build/Ruby-driver-v2.19/lib/ mongo /crypt/ KMS / Amazon Web Services /credentials.rb', 第67行

def to_document
  return BSON::文档.new if 空？
  BSON::文档.new({
    accessKeyId: access_key_id,
    secretAccessKey: secret_access_key,
  }).点击 do |bson|
    除非 session_token.nil?
      bson.update({ sessionToken： session_token })
    end
  end
end