翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateLedger
現在のリージョンの AWS アカウント に新しい台帳を作成します。
リクエストの構文
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
-
台帳に保管中のデータの暗号化に使用する 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 キーを指定するには、その 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
詳細については、「 AWS Key Management Service デベロッパーガイド」の「キー識別子 (KeyId)」を参照してください。
型: 文字列
長さの制限: 最大長は 1600
必須: いいえ
-
- Name
-
作成する台帳の名前。名前は、現在のリージョンの 内のすべての台帳 AWS アカウント 間で一意である必要があります。
台帳名の命名に関する制約は、「Amazon QLDB デベロッパーガイド」の「Amazon QLDB のクォータ」で定義されています。
型: 文字列
長さの制限:最小長は 1 です。最大長は 32 です。
Pattern:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
必須:はい
- PermissionsMode
-
作成する台帳に割り当てるアクセス許可モード。このパラメータには以下の値のいずれかがあります。
-
ALLOW_ALL
: 台帳のAPIレベル詳細度でアクセス制御を可能にする、レガシーアクセス許可モードこのモードは、この台帳の
SendCommand
API アクセス許可を持つユーザーが、指定された台帳の任意のテーブルで、すべての PartiQL コマンド (すなわちALLOW_ALL
) を実行することを許可します。このモードでは、台帳用に作成したテーブルレベルまたはコマンドレベルの IAM アクセス許可ポリシーはすべて無視されます。 -
STANDARD
: (推奨) 台帳、テーブル、PartiQL コマンドの、より詳細なレベルのアクセス許可を可能にするアクセス許可モード。デフォルトでは、このモードは、この台帳内の任意のテーブルで、任意の PartiQL コマンドを実行するすべてのユーザーリクエストを拒否します。PartiQL コマンドの実行を許可するには、台帳の
SendCommand
API アクセス許可に加えて、特定のテーブルリソースと PartiQL アクション用の IAM アクセス許可ポリシーを作成する必要があります。詳細については、Amazon QLDB デベロッパーガイドの Getting started with the standard permissions mode を参照してください。
注記
台帳データのセキュリティを最大化する、
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 です。最大長は 1600 です。
- CreationDateTime
-
台帳が作成された日時 (エポック時刻形式)。(エポック時間形式は 1970 年 1 月 1 日 12:00:00 AM UTC からの経過秒数です。)
型: タイムスタンプ
- DeletionProtection
-
台帳がユーザーによって削除されないように保護されるかどうかを指定します。台帳の作成時に指定しない場合、この機能はデフォルトで有効
true
になります。削除保護が有効になっている場合は、台帳を削除する前に、まず無効にする必要があります。無効にするには、
UpdateLedger
オペレーションを呼び出してパラメータをfalse
に設定します。型: ブール値
- KmsKeyArn
-
台帳が保管時の暗号化に使用する、カスタマーマネージド KMS キーの ARN。このパラメータが未定義の場合、台帳は暗号化に AWS 所有の KMS キーを使用します。
型: 文字列
長さの制限: 最小長は 20 です。最大長は 1600 です。
- Name
-
台帳の名前。
型: 文字列
長さの制限:最小長は 1 です。最大長は 32 です。
パターン:
(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$
- PermissionsMode
-
作成した台帳のアクセス許可モード。
型: 文字列
有効な値:
ALLOW_ALL | STANDARD
- State
-
台帳の現在のステータス。
型: 文字列
有効な値:
CREATING | ACTIVE | DELETING | DELETED
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterException
-
リクエスト内の 1 つ以上のパラメータが有効ではありません。
HTTP ステータスコード:400
- LimitExceededException
-
許可されているリソースの最大数の制限に達しました。
HTTP ステータスコード:400
- ResourceAlreadyExistsException
-
指定されたリソースは既に存在します。
HTTP ステータスコード: 409
- ResourceInUseException
-
指定されたリソースは、現時点では変更できません。
HTTP ステータスコード: 409
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。