Request Syntax URI 요청 파라미터 요청 본문 응답 구문 응답 요소 Errors 참고

UpdateLedger

원장의 속성을 업데이트합니다.

Request Syntax


PATCH /ledgers/name HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string"
}

URI 요청 파라미터

요청은 다음 URI 파라미터를 사용합니다.

name

원장의 명칭입니다.

길이 제약 조건: 최소 길이는 1입니다. 최대 길이 32.

패턴: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

필수: 예

요청 본문

요청은 JSON 형식으로 다음 데이터를 받습니다.

DeletionProtection

사용자에 의해 삭제되지 않도록 원장을 보호할지 여부를 지정합니다. 원장 생성 중 정의하지 않을 경우 이 기능이 기본적으로 활성화됩니다(true).

삭제 방지가 활성화된 경우 원장을 삭제하려면 먼저 이 기능을 비활성화해야 합니다. UpdateLedger 작업을 호출하여 이 파라미터를 false로 설정하면 비활성화할 수 있습니다.

타입: 부울

필수 항목 여부: 아니요

KmsKey

원장에 저장된 데이터를 암호화하는 데 사용할 키 in AWS Key Management Service (AWS KMS) 입니다. 자세한 내용을 알아보려면 Amazon QLDB 개발자 안내서의 저장된 암호화를 참조하세요.

다음 옵션 중 하나를 사용하여 이 파라미터를 지정합니다.

AWS_OWNED_KMS_KEY: 본인 대신 소유하고 AWS 관리하는 AWS KMS 키를 사용하십시오.
정의되지 않음: 원장의 KMS 키를 변경하지 않습니다.
유효한 대칭 고객 관리형 KMS 키: 사용자가 생성, 소유 및 관리하는 계정의 지정된 대칭 암호화 KMS 키를 사용합니다.

Amazon QLDB에서는 비대칭 키가 지원되지 않습니다. 자세한 내용은 개발자 안내서의 대칭 및 비대칭 키 사용을 참조하십시오. AWS Key Management Service

고객 관리형 KMS 키를 지정하려면 해당 키 ID, Amazon 리소스 이름(ARN), 별칭 이름 또는 별칭 ARN을 사용할 수 있습니다. 별칭 이름을 사용할 때 "alias/"를 접두사를 사용합니다. 다른 AWS 계정키를 지정하려면 키 ARN 또는 별칭 ARN을 사용해야 합니다.

예:

키 ID: 1234abcd-12ab-34cd-56ef-1234567890ab
키 ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
별칭 이름: alias/ExampleAlias
별칭 ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

자세한 내용은 개발자 안내서의 키 식별자 (KeyId) 를 참조하십시오. AWS Key Management Service

타입: 문자열

길이 제약 조건: 최대 길이는 1,600입니다.

필수 항목 여부: 아니요

응답 구문


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "EncryptionDescription": { 
      "EncryptionStatus": "string",
      "InaccessibleKmsKeyDateTime": number,
      "KmsKeyArn": "string"
   },
   "Name": "string",
   "State": "string"
}