클래스: Mongo::Crypt::KMS::AWS::MasterKeyDocument 비공개

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

개요

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

Amazon Web Services KMS 마스터 키 문서 객체 에는 KMS 마스터 키 매개변수가 포함되어 있습니다.

상수 요약 접기

FORMAT_HINT =

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

"Amazon Web Services 키 문서 는 다음 형식이어야 합니다. " +
"{ region: 'REGION', key: 'KEY' }"

인스턴스 속성 요약 접기

인스턴스 메서드 요약 접기

유효성 검사에 포함된 메서드

#validate_param, validate_tls_options

생성자 세부 정보

#initialize(opts) ⇒ MasterKeyDocument

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

매개변수 해시 형식으로 마스터 키 문서 객체를 생성합니다.

매개변수:

  • opts (해시) —

    Amazon Web Services KMS 제공자에 대한 마스터 키 옵션이 포함된 해시입니다.

옵션 해시(opts):

  • : 리전 (string) —

    Amazon Web Services 리전.

  • :key (string) —

    Amazon Web Services KMS 키.

  • :endpoint (string | nil) —

    Amazon Web Services KMS 엔드포인트, 선택 사항.

다음을 발생시킵니다.

  • (ArgumentError) —

    필수 옵션이 누락되었거나 잘못된 경우.



49
50
51
52
53
54
55
56
57
58
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Amazon Web Services/master_document.rb', 줄 49

def 초기화(opts)
  하지 않는 한 opts.is_a?(해시)
    올리다 ArgumentError.신규(
      '키 문서 옵션에는 해시 값이 있는 :master_key라는 키가 포함되어야 합니다.'
    )
  end
  @ 리전 = validate_param(: 리전, opts, FORMAT_HINT)
  @key = validate_param(:key, opts, FORMAT_HINT)
  @endpoint = validate_param(:endpoint, opts, FORMAT_HINT, 필수: 거짓)
end

인스턴스 속성 세부 정보

#엔드포인트 ⇒ string | nil (읽기 전용)

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

Amazon Web Services KMS 엔드포인트를 반환합니다.

반환합니다:

  • (string | nil) —

    Amazon Web Services KMS 엔드포인트.



35
36
37
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Amazon Web Services/master_document.rb', 줄 35

def 엔드포인트
  @endpoint
end

#키 ⇒ string (읽기 전용)

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

Amazon Web Services KMS 키를 반환합니다.

반환합니다:

  • (string) —

    Amazon Web Services KMS 키.



32
33
34
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Amazon Web Services/master_document.rb', 줄 32

def 키
  @key
end

#리전 ⇒ string (읽기 전용)

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

Amazon Web Services 리전을 반환합니다.

반환합니다:

  • (string) —

    Amazon Web Services 리전.



29
30
31
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Amazon Web Services/master_document.rb', 줄 29

def 리전
  @ 리전
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
 
# 파일 ' 빌드/ Ruby-driver-v2.19/lib/mongo/crypt/KMS/Amazon Web Services/master_document.rb', 줄 63

def to_document
  BSON::문서.신규({
    제공자: 'aws',
    리전: 리전,
    키: 키,
  }).탭 do |BSON|
    하지 않는 한 엔드포인트.nil?
      BSON.update({ 엔드포인트: 엔드포인트 })
    end
  end
end