CreateLedger - 아마존 퀀텀 레저 데이터베이스 (아마존QLDB)
Request SyntaxURI 요청 파라미터요청 본문응답 구문응답 요소Errors참고

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

CreateLedger

현재 지역의 새 원장을 생성합니다. AWS 계정

Request Syntax

POST /ledgers HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI 요청 파라미터

요청은 URI 파라미터를 사용하지 않습니다.

요청 본문

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

DeletionProtection

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

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

타입: 부울

필수 항목 여부: 아니요

KmsKey

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

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

  • AWS_OWNED_KMS_KEY: 본인 대신 소유하고 AWS 관리하는 AWS KMS 키를 사용하십시오.

  • 미정: 기본적으로 AWS 소유한 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입니다.

필수 여부: 아니요

Name

생성할 원장의 이름입니다. 이름은 현재 지역의 모든 원장 중에서 고유해야 합니다 AWS 계정 .

원장 이름에 대한 이름 지정 제약 조건은 Amazon QLDB 개발자 안내서의 Amazon QLDB의 할당량에 정의되어 있습니다.

유형: 문자열

길이 제약: 최소 길이 1. 최대 길이 32.

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

필수 사항 여부: Yes

PermissionsMode

생성하려는 원장에 할당할 권한 모드입니다. 이 파라미터는 다음 값 중 하나를 가질 수 있습니다.

  • ALLOW_ALL: 원장에 대한 API 수준 세분화로 액세스 통제를 가능하게 하는 레거시 권한 모드입니다.

    이 모드를 사용하면 이 원장에 대한 SendCommand API 권한이 있는 사용자가 지정된 원장의 모든 표에서 모든 PartiQL 명령(따라서 ALLOW_ALL)을 실행할 수 있습니다. 이 모드는 원장에 대해 생성하는 모든 표 수준 또는 명령 수준 IAM 권한 정책을 무시합니다.

  • STANDARD: (권장) 원장, 테이블 및 PartiQL 명령에 대해 보다 세분화된 액세스 제어를 가능하게 하는 권한 모드입니다..

    기본적으로 이 모드는 이 원장의 모든 표에서 PartiQL 명령을 실행하려는 모든 사용자 요청을 거부합니다. PartiQL 명령 실행을 허용하려면 원장에 대한 SendCommand API 권한 외에도 특정 테이블 리소스 및 PartiQL 작업에 대한 IAM 권한 정책을 생성해야 합니다. 자세한 내용은 Amazon QLDB 개발자 안내서의 표준 권한 모드로 시작하기를 참조하세요.

참고

원장 데이터의 보안을 극대화하려면 STANDARD 권한 모드를 사용하는 것이 좋습니다.

타입: 문자열

유효 값: ALLOW_ALL | STANDARD

필수 사항 여부: 예

Tags

생성할 원장에 태그로 추가하려는 키-값 쌍입니다. 태그 키는 대소문자를 구별합니다. 태그 값은 대소문자를 구분하며 null일 수 있습니다.

유형: 문자열 간 맵

맵 항목: 최소 항목 수는 0개입니다. 최대 항목 수 200개.

키 길이 제약 조건: 최소 길이는 1. 최대 길이 128.

값 길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 256입니다.

필수 여부: 아니요

응답 구문

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "KmsKeyArn": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "State": "string"
}

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

Arn

원장의 Amazon 리소스 이름(ARN)입니다.

타입: 문자열

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

CreationDateTime

원장이 생성된 날짜와 시간(epoch 시간 형식)입니다. (epoch 시간 형식은 UTC 기준으로 1970년 1월 1일 자정 12:00:00부터 경과된 초 단위의 시간입니다.)

유형: 타임스탬프

DeletionProtection

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

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

타입: 부울

KmsKeyArn

원장이 유휴 시 암호화에 사용하는 고객 관리형 KMS 키의 ARN입니다. 이 매개변수가 정의되지 않은 경우 원장은 AWS 소유한 KMS 키를 암호화에 사용합니다.

타입: 문자열

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

Name

원장의 명칭입니다.

타입: 문자열

길이 제약: 최소 길이 1. 최대 길이 32.

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

PermissionsMode

생성한 원장의 권한 모드입니다.

타입: 문자열

유효 값: ALLOW_ALL | STANDARD

State

원장의 현재 상태입니다.

타입: 문자열

유효 값: CREATING | ACTIVE | DELETING | DELETED

Errors

모든 작업에서 발생하는 흔한 오류에 대한 자세한 내용은 일반적인 오류 섹션을 참조하십시오.

InvalidParameterException

요청에서 하나 이상의 파라미터가 유효하지 않습니다.

HTTP 상태 코드: 400

LimitExceededException

허용되는 최대 리소스 수 제한에 도달했습니다.

HTTP 상태 코드: 400

ResourceAlreadyExistsException

지정된 리소스가 이미 있습니다.

HTTP 상태 코드: 409

ResourceInUseException

지금은 지정된 리소스를 수정할 수 없습니다.

HTTP 상태 코드: 409

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.