CreateLedger - Database Buku Besar Amazon Quantum (AmazonQLDB)
Minta SintaksParameter Permintaan URIIsi PermintaanSintaksis ResponsElemen ResponsKesalahanLihat Juga

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

CreateLedger

Membuat buku besar baru di Wilayah Anda Akun AWS saat ini.

Minta Sintaks

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

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

Parameter Permintaan URI

Permintaan tidak menggunakan parameter URI apa pun.

Isi Permintaan

Permintaan menerima data berikut dalam format JSON.

DeletionProtection

Menentukan apakah buku besar dilindungi dari dihapus oleh setiap pengguna. Jika tidak ditentukan selama pembuatan buku besar, fitur ini diaktifkan (true) secara default.

Jika perlindungan penghapusan diaktifkan, Anda harus menonaktifkannya terlebih dahulu sebelum dapat menghapus buku besar. Anda dapat menonaktifkannya dengan memanggil UpdateLedger operasi untuk mengatur parameter inifalse.

Tipe: Boolean

Wajib: Tidak

KmsKey

Kunci in AWS Key Management Service (AWS KMS) yang akan digunakan untuk enkripsi data saat istirahat di buku besar. Untuk informasi selengkapnya, lihat Enkripsi saat istirahat di Panduan Pengembang QLDB Amazon.

Gunakan salah satu opsi berikut untuk menentukan parameter ini:

  • AWS_OWNED_KMS_KEY: Gunakan AWS KMS kunci yang dimiliki dan dikelola oleh AWS atas nama Anda.

  • Undefined: Secara default, gunakan kunci KMS yang AWS dimiliki.

  • Kunci KMS terkelola pelanggan simetris yang valid: Gunakan kunci KMS enkripsi simetris yang ditentukan di akun yang Anda buat, miliki, dan kelola.

    Amazon QLDB tidak mendukung kunci asimetris. Untuk informasi selengkapnya, lihat Menggunakan kunci simetris dan asimetris di Panduan AWS Key Management Service Pengembang.

Untuk menentukan kunci KMS yang dikelola pelanggan, Anda dapat menggunakan ID kunci, Nama Sumber Daya Amazon (ARN), nama alias, atau alias ARN. Saat menggunakan nama alias, awali dengan. "alias/" Untuk menentukan kunci yang berbeda Akun AWS, Anda harus menggunakan kunci ARN atau alias ARN.

Sebagai contoh:

  • ID Kunci: 1234abcd-12ab-34cd-56ef-1234567890ab

  • ARN kunci: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Nama alias: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

Untuk informasi selengkapnya, lihat Pengidentifikasi kunci (KeyId) di Panduan AWS Key Management Service Pengembang.

Jenis: String

Kendala Panjang: Panjang maksimum 1600.

Wajib: Tidak

Name

Nama buku besar yang ingin Anda buat. Nama harus unik di antara semua buku besar di Wilayah Anda Akun AWS saat ini.

Batasan penamaan untuk nama buku besar didefinisikan dalam Kuota di Amazon QLDB dalam Panduan Developer Amazon QLDB.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 32.

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

Wajib: Ya

PermissionsMode

Mode izin untuk ditetapkan ke buku besar yang ingin Anda buat. parameter ini dapat memiliki salah satu nilai berikut:

  • ALLOW_ALL: Mode izin warisan yang memungkinkan kontrol akses dengan rincian tingkat API untuk buku besar.

    Mode ini memungkinkan pengguna yang memiliki izin API SendCommand untuk buku besar ini untuk menjalankan semua perintah PartiQL (maka, ALLOW_ALL) pada setiap tabel dalam buku besar yang ditentukan. Mode ini mengabaikan setiap kebijakan izin IAM tingkat tabel atau tingkat perintah yang Anda buat untuk buku besar.

  • STANDARD: (Direkomendasikan) Mode perizinan yang memungkinkan kontrol akses dengan rincian yang lebih halus untuk buku besar, tabel, dan perintah PartiQL.

    Secara default, mode ini menyangkal semua permintaan pengguna untuk menjalankan perintah PartiQL pada setiap tabel dalam buku besar ini. Untuk mengizinkan perintah PartiQL untuk berjalan, Anda harus membuat kebijakan izin IAM untuk sumber daya tabel tertentu dan tindakan PartiQL, selain izin API SendCommand untuk buku besar. Untuk informasi, lihat Memulai dengan mode izin standar dalam Panduan Developer Amazon QLDB.

catatan

Kami sangat merekomendasikan untuk menggunakan mode izin STANDARD untuk memaksimalkan keamanan data buku besar Anda.

Jenis: String

Nilai yang Valid: ALLOW_ALL | STANDARD

Wajib: Ya

Tags

Pasangan kunci-nilai untuk ditambahkan sebagai tag ke buku besar yang ingin Anda buat. Kunci tag peka huruf besar dan kecil. Nilai tag peka huruf besar/kecil dan bisa null.

Tipe: Peta string ke string

Entri Peta: Jumlah minimum 0 item. Jumlah maksimum 200 item.

Batasan Panjang Kunci: Panjang minimum 1. Panjang maksimum 128.

Batasan Panjang Nilai: Panjang minimum 0. Panjang maksimum 256.

Wajib: Tidak

Sintaksis Respons

HTTP/1.1 200
Content-type: application/json

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

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

Arn

Nama Sumber Daya Amazon (ARN) untuk buku besar.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

CreationDateTime

Tanggal dan waktu, dalam format waktu epoch, saat buku besar dibuat. (Format waktu zaman adalah jumlah detik yang berlalu sejak 12:00:00 1 Januari 1970 UTC.)

Tipe: Timestamp

DeletionProtection

Menentukan apakah buku besar dilindungi dari dihapus oleh setiap pengguna. Jika tidak ditentukan selama pembuatan buku besar, fitur ini diaktifkan (true) secara default.

Jika perlindungan penghapusan diaktifkan, Anda harus menonaktifkannya terlebih dahulu sebelum dapat menghapus buku besar. Anda dapat menonaktifkannya dengan memanggil UpdateLedger operasi untuk mengatur parameter inifalse.

Jenis: Boolean

KmsKeyArn

ARN dari kunci KMS yang dikelola pelanggan yang digunakan buku besar untuk enkripsi saat istirahat. Jika parameter ini tidak terdefinisi, buku besar menggunakan kunci KMS yang AWS dimiliki untuk enkripsi.

Jenis: String

Batasan Panjang: Panjang minimum 20. Panjang maksimum 1600.

Name

Nama buku besar.

Jenis: String

Batasan Panjang: Panjang minimum 1. Panjang maksimum 32.

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

PermissionsMode

Mode izin buku besar yang Anda buat.

Jenis: String

Nilai yang Valid: ALLOW_ALL | STANDARD

State

Status buku besar saat ini.

Jenis: String

Nilai yang Valid: CREATING | ACTIVE | DELETING | DELETED

Kesalahan

Untuk informasi tentang kesalahan yang umum untuk semua tindakan, lihat Kesalahan Umum.

InvalidParameterException

Satu atau beberapa parameter dalam permintaan tidak valid.

Kode Status HTTP: 400

LimitExceededException

Anda telah mencapai batas jumlah maksimum sumber daya yang diizinkan.

Kode Status HTTP: 400

ResourceAlreadyExistsException

Sumber daya yang ditentukan sudah ada.

Kode Status HTTP: 409

ResourceInUseException

Sumber daya yang ditentukan tidak dapat dimodifikasi saat ini.

Kode Status HTTP: 409

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: