클래스: Mongo::Crypt::KMS::AWS::Credentials Private

상속:
객체
  • 객체
모두 표시
확장자:
전달 가능
다음을 포함합니다.
유효성 검사
다음에 정의됨:
build/ruby-driver-v2.19/lib/mongo/crypt/KMS/Amazon Web Services/credentials.rb

개요

이 클래스는 비공개 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
 
# 파일 '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, 필수: 거짓)
  end
end

인스턴스 속성 세부 정보

#access_key_id ⇒ string (읽기 전용)

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

Amazon Web Services 액세스 키를 반환합니다.

반환합니다:

  • (string) —

    Amazon Web Services 액세스 키.



31
32
33
 
# 파일 '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
 
# 파일 '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
 
# 파일 '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
 
# 파일 'build/ruby-driver-v2.19/lib/mongo/crypt/KMS/Amazon Web Services/credentials.rb', 줄 67

def to_document
  반환 BSON::문서.신규 만약 비어 있나요?
  BSON::문서.신규({
    accessKeyId: access_key_id,
    secretAccessKey: secret_access_key,
  }).탭 do |BSON|
    하지 않는 한 session_token.nil?
      BSON.update({ sessionToken: session_token })
    end
  end
end