API Parameter Neptune - Amazon Neptune
CopyDBParameterGroupCopyDBClusterParameterGroupdibuatDBParameterGroupdibuatDBClusterParameterGroupDeleteDBParameterGroupDeleteDBClusterParameterGroupModifyDBParameterGroupModifyDBClusterParameterGroupResetDBParameterGroupResetDBClusterParameterGroupDescribeDBParametersDijelaskanBParameterGroupsDijelaskanBClusterParametersDijelaskanBClusterParameterGroupsDescribeEngineDefaultParametersDescribeEngineDefaultClusterParameters________________________ParameterDBParameterGroupDBClusterParameterGroupDBParameterGroupStatus

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

API Parameter Neptune

Tindakan:

Struktur:

CopyDBParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:copy-db-parameter-group.

Menyalin grup parameter DB yang ditentukan.

Permintaan

  • SourceDBParameterGroupIdentifier(di CLI:--source-db-parameter-group-identifier) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Pengenal atau ARN untuk grup parameter DB sumber. Untuk informasi tentang pembuatan ARN, lihat Pembangunan Amazon Resource Name (ARN).

    Kendala:

    • Harus menentukan grup parameter DB yang valid.

    • Harus menentukan pengenal grup parameter DB yang valid, misalnya my-db-param-group, atau ARN yang valid.

  • Tags(di CLI:--tags) - Array dariTandabenda.

    Tag yang ditetapkan ke grup parameter DB yang disalin.

  • TargetDBParameterGroupDescription(di CLI:--target-db-parameter-group-description) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Deskripsi untuk grup parameter DB yang disalin.

  • TargetDBParameterGroupIdentifier(di CLI:--target-db-parameter-group-identifier) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Pengidentifikasi untuk grup parameter DByang disalin.

    Kendala:

    • Tidak dapat berupa null, kosong, atau blank.

    • Harus berisi antara 1 hingga 255 huruf, angka, atau tanda hubung.

    • Karakter pertama harus berupa huruf.

    • Tidak dapat diakhiri dengan tanda hubung atau berisi dua tanda hubung berurutan.

    Contoh: my-db-parameter-group

Respon

Berisi detail dari grup parameter Amazon Neptune DB.

Tipe data ini digunakan sebagai elemen respon dalam tindakan DijelaskanBParameterGroups(tindakan).

  • DBParameterGroupArn- String, tipe:string(string yang dikodekan UTF-8).

    Amazon Resource Name (ARN) untuk grup parameter DB.

  • DBParameterGroupFamily- String, tipe:string(string yang dikodekan UTF-8).

    Memberikan nama keluarga grup parameter DB yang kompatibel dengan grup parameter DB ini.

  • DBParameterGroupName- String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan nama grup parameter DB.

  • Description- String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan deskripsi yang ditentukan pelanggan untuk grup parameter DB ini.

Kesalahan

CopyDBClusterParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:copy-db-cluster-parameter-group.

Salinan grup parameter klaster DB tertentu.

Permintaan

  • SourceDBClusterParameterGroupIdentifier(di CLI:--source-db-cluster-parameter-group-identifier) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Pengenal atau Amazon Resource Name (ARN) untuk grup parameter klaster DB sumber. Untuk informasi tentang pembuatan ARN, lihat Pembangunan Amazon Resource Name (ARN).

    Kendala:

    • Harus menentukan grup parameter klaster DB yang valid.

    • Jika grup parameter klaster sumber berada dalam Wilayah Amazon yang sama dengan salinannya, tentukan pengenal grup parameter DB yang valid, misalnya my-db-cluster-param-group, atau ARN yang valid.

    • Jika grup parameter sumber berada dalam Wilayah Amazon yang berbeda dari salinannya, tentukan ARN grup parameter klaster DB yang valid, misalnya arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

  • Tags(di CLI:--tags) - Array dariTandabenda.

    Tag yang akan ditugaskan ke grup parameter klaster DB yang disalin.

  • TargetDBClusterParameterGroupDescription(di CLI:--target-db-cluster-parameter-group-description) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Deskripsi untuk grup parameter klaster DB yang disalin.

  • TargetDBClusterParameterGroupIdentifier(di CLI:--target-db-cluster-parameter-group-identifier) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Pengenal untuk grup parameter klaster DB yang disalin.

    Kendala:

    • Tidak dapat berupa null, kosong, atau blank

    • Harus berisi antara 1 hingga 255 huruf, angka, atau tanda hubung

    • Karakter pertamanya harus berupa huruf

    • Tidak boleh diakhiri dengan tanda hubung atau berisi dua tanda hubung yang berurutan

    Contoh: my-cluster-param-group1

Respon

Berisi detail dari grup parameter klaster Amazon Neptune DB.

Tipe data ini digunakan sebagai elemen respon dalam tindakan DijelaskanBClusterParameterGroups(tindakan).

  • DBClusterParameterGroupArn- String, tipe:string(string yang dikodekan UTF-8).

    Amazon Resource Name (ARN) untuk grup parameter klaster DB.

  • DBClusterParameterGroupName- String, tipe:string(string yang dikodekan UTF-8).

    Memberikan nama grup parameter klaster DB.

  • DBParameterGroupFamily- String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan nama keluarga grup parameter DB yang kompatibel dengan grup parameter klaster DB ini.

  • Description- String, tipe:string(string yang dikodekan UTF-8).

    Memberikan deskripsi khusus pelanggan untuk grup parameter klaster DB ini.

Kesalahan

dibuatDBParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:create-db-parameter-group.

Membuat grup parameter DB baru.

Grup parameter DB awalnya dibuat dengan parameter default untuk mesin basis data yang digunakan oleh instans DB. Untuk memberikan nilai kustom untuk salah satu parameter, Anda harus memodifikasi grup setelah membuatnya menggunakanModifyDBParameterGroup. Setelah Anda membuat grup parameter DB, Anda perlu mengaitkannya dengan instans DB menggunakan ModifyDBInstance. Ketika Anda mengaitkan grup parameter DB baru dengan instans DB yang berjalan, Anda perlu but ulang instans DB tanpa failover untuk grup parameter DB baru dan pengaturan terkait agar berlaku.

penting

Setelah Anda membuat grup parameter DB, Anda harus menunggu setidaknya 5 menit sebelum membuat instans DB pertama Anda yang menggunakan grup parameter DB tersebut sebagai grup parameter default. Ini memungkinkan Amazon Neptune untuk sepenuhnya menyelesaikan tindakan pembuatan sebelum grup parameter digunakan sebagai default untuk instans DB baru. Ini penting khususnya untuk parameter yang sangat penting saat membuat basis data default untuk sebuah instans DB, seperti set karakter untuk basis data default yang ditentukan oleh parameter character_set_database. Anda dapat menggunakan pilihan Grup Parameter konsol Amazon Neptune atau perintah DescribeDBParameters untuk memverifikasi bahwa grup parameter DB Anda telah dibuat atau diubah.

Permintaan

  • DBParameterGroupFamily(di CLI:--db-parameter-group-family) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama keluarga grup parameter DB. Grup parameter DB dapat dikaitkan dengan satu dan hanya satu keluarga grup parameter DB, dan hanya dapat diterapkan ke instans DB yang menjalankan mesin basis data dan versi mesin yang kompatibel dengan keluarga grup parameter DB tersebut.

  • DBParameterGroupName(di CLI:--db-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter DB.

    Kendala:

    • Harus berisi 1 sampai 255 huruf, angka, atau tanda hubung.

    • Karakter pertamanya harus berupa huruf

    • Tidak boleh diakhiri dengan tanda hubung atau berisi dua tanda hubung yang berurutan

    catatan

    Nilai ini disimpan sebagai string huruf kecil.

  • Description(di CLI:--description) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Deskripsi untuk grup parameter DB.

  • Tags(di CLI:--tags) - Array dariTandabenda.

    Tag yang akan ditugaskan ke grup parameter DB baru.

Respon

Berisi detail dari grup parameter Amazon Neptune DB.

Tipe data ini digunakan sebagai elemen respon dalam tindakan DijelaskanBParameterGroups(tindakan).

  • DBParameterGroupArn- String, tipe:string(string yang dikodekan UTF-8).

    Amazon Resource Name (ARN) untuk grup parameter DB.

  • DBParameterGroupFamily- String, tipe:string(string yang dikodekan UTF-8).

    Memberikan nama keluarga grup parameter DB yang kompatibel dengan grup parameter DB ini.

  • DBParameterGroupName- String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan nama grup parameter DB.

  • Description- String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan deskripsi yang ditentukan pelanggan untuk grup parameter DB ini.

Kesalahan

dibuatDBClusterParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:create-db-cluster-parameter-group.

Membuat grup parameter klaster DB baru.

Parameter dalam grup parameter klaster DB berlaku untuk semua instans dalam sebuah klaster DB.

Grup parameter klaster DB awalnya dibuat dengan parameter default untuk mesin basis data yang digunakan oleh instans dalam klaster DB. Untuk menyediakan nilai kustom bagi parameter apa pun, Anda harus mengubah grup setelah membuatnya menggunakan ModifyDBClusterParameterGroup(tindakan). Setelah Anda membuat grup parameter klaster DB, Anda perlu mengaitkannya dengan klaster DB Anda menggunakan ModifyDBCluster (tindakan). Ketika Anda mengaitkan grup parameter klaster DB baru dengan klaster DB yang berjalan, Anda perlu melakukan reboot instans DB di dalam klaster DB tanpa failover untuk grup parameter klaster DB baru dan pengaturan terkait agar berlaku.

penting

Setelah Anda membuat grup parameter klaster DB, Anda harus menunggu setidaknya 5 menit sebelum membuat klaster DB pertama Anda yang menggunakan grup parameter klaster DB tersebut sebagai grup parameter default. Ini memungkinkan Amazon Neptune untuk sepenuhnya menyelesaikan tindakan pembuatan sebelum grup parameter klaster DB digunakan sebagai default untuk klaster DB baru. Ini penting khususnya untuk parameter yang sangat penting saat membuat basis data default untuk sebuah klaster DB, seperti set karakter untuk basis data default yang ditentukan oleh parameter character_set_database. Anda dapat menggunakan pilihan Grup Parameter dari Amazon Neptune console atau perintahDijelaskanBClusterParameters(tindakan) untuk memverifikasi bahwa grup parameter klaster DB Anda telah dibuat atau diubah.

Permintaan

  • DBClusterParameterGroupName(di CLI:--db-cluster-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter klaster.

    Batasan:

    • Harus cocok dengan nama DB yang adaClusterParameterGroup.

    catatan

    Nilai ini disimpan sebagai string huruf kecil.

  • DBParameterGroupFamily(di CLI:--db-parameter-group-family) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama keluarga grup parameter klaster DB. Grup parameter DB dapat dikaitkan dengan satu dan hanya satu keluarga grup parameter klaster DB, dan hanya dapat diterapkan ke klaster DB yang menjalankan mesin basis data dan versi mesin yang kompatibel dengan keluarga grup parameter klaster DB tersebut.

  • Description(di CLI:--description) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Deskripsi untuk grup parameter klaster DB.

  • Tags(di CLI:--tags) - Array dariTandabenda.

    Tag yang akan ditugaskan ke grup parameter kluster DB baru.

Respon

Berisi detail dari grup parameter klaster Amazon Neptune DB.

Tipe data ini digunakan sebagai elemen respon dalam tindakan DijelaskanBClusterParameterGroups(tindakan).

  • DBClusterParameterGroupArn- String, tipe:string(string yang dikodekan UTF-8).

    Amazon Resource Name (ARN) untuk grup parameter klaster DB.

  • DBClusterParameterGroupName- String, tipe:string(string yang dikodekan UTF-8).

    Memberikan nama grup parameter klaster DB.

  • DBParameterGroupFamily- String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan nama keluarga grup parameter DB yang kompatibel dengan grup parameter klaster DB ini.

  • Description- String, tipe:string(string yang dikodekan UTF-8).

    Memberikan deskripsi khusus pelanggan untuk grup parameter klaster DB ini.

Kesalahan

DeleteDBParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:delete-db-parameter-group.

Menghapus DB tertentuParameterGroup. DBParameterGroupyang akan dihapus tidak dapat dikaitkan dengan instans DB apa pun.

Permintaan

  • DBParameterGroupName(di CLI:--db-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter DB.

    Kendala:

    • Harus nama grup parameter DB yang ada

    • Anda tidak dapat menhapus grup parameter DB.

    • Tidak dapat dikaitkan dengan instans DB apapun

Response

  • Tidak ada parameter Respon.

Kesalahan

DeleteDBClusterParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:delete-db-cluster-parameter-group.

Menghapus grup parameter klaster DB tertentu. Grup parameter klaster DB yang akan dihapus tidak dapat dikaitkan dengan klaster DB apa pun.

Permintaan

  • DBClusterParameterGroupName(di CLI:--db-cluster-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter klaster.

    Kendala:

    • Harus nama grup parameter kluster DB yang sudah ada.

    • Anda tidak dapat menghapus grup parameter klaster DB default.

    • Tidak dapat dikaitkan dengan klaster DB mana pun.

Response

  • Tidak ada parameter Respon.

Kesalahan

ModifyDBParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:modify-db-parameter-group.

Memodifikasi parameter dari grup parameter DB. Untuk mengubah lebih dari satu parameter, kirimkan daftar berikut ini: ParameterName, ParameterValue, and ApplyMethod. Maksimum 20 parameter dapat dimodifikasi dalam satu permintaan.

catatan

Perubahan pada parameter dinamis langsung diterapkan. Perubahan parameter statis memerlukan reboot tanpa failover ke instans DB yang terkait dengan grup parameter sebelum perubahan dapat berlaku.

penting

Setelah Anda mengubah grup parameter DB, tunggu setidaknya 5 menit sebelum membuat instans DB pertama Anda yang menggunakan grup parameter DB tersebut sebagai grup parameter default. Ini memungkinkan Amazon Neptune untuk sepenuhnya menyelesaikan tindakan pembuatan sebelum grup parameter digunakan sebagai default untuk instans DB baru. Ini penting khususnya untuk parameter yang sangat penting saat membuat basis data default untuk sebuah instans DB, seperti set karakter untuk basis data default yang ditentukan oleh parameter character_set_database. Anda dapat menggunakan pilihan Grup Parameter konsol Amazon Neptune atau perintah DescribeDBParameters untuk memverifikasi bahwa grup parameter DB Anda telah dibuat atau diubah.

Permintaan

  • DBParameterGroupName(di CLI:--db-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter DB.

    Batasan:

    • Jika disediakan, harus sesuai dengan nama DB yang adaParameterGroup.

  • Parameters(di CLI:--parameters) —Diperlukan:Array dariParameterbenda.

    Array nama parameter, nilai dan metode penerapan untuk pembaruan parameter. Setidaknya satu nama parameter, nilai, dan metode penerapan harus disediakan; argumen berikutnya adalah opsional. Maksimum 20 parameter dapat dimodifikasi dalam satu permintaan.

    Nilai yang Valid (untuk metode aplikasi): immediate | pending-reboot

    catatan

    Anda dapat menggunakan nilai langsung dengan parameter dinamis saja. Anda dapat menggunakan nilai pending-reboot untuk parameter dinamis dan statis, dan perubahan diterapkan ketika Anda melakukan reboot instans DB tanpa failover.

Respon

  • DBParameterGroupName- String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan nama grup parameter DB.

Kesalahan

ModifyDBClusterParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:modify-db-cluster-parameter-group.

Memodifikasi parameter dari grup parameter klaster DB. Untuk mengubah lebih dari satu parameter, kirimkan daftar berikut ini: ParameterName, ParameterValue, and ApplyMethod. Maksimum 20 parameter dapat dimodifikasi dalam satu permintaan.

catatan

Perubahan pada parameter dinamis langsung diterapkan. Perubahan ke parameter statis memerlukan reboot tanpa failover ke cluster DB terkait dengan grup parameter sebelum perubahan dapat berlaku.

penting

Setelah Anda membuat grup parameter klaster DB, Anda harus menunggu setidaknya 5 menit sebelum membuat klaster DB pertama Anda yang menggunakan grup parameter klaster DB tersebut sebagai grup parameter default. Ini mengizinkan Amazon Neptune dapat menyelesaikan sepenuhnya tindakan pembuatan sebelum grup parameter digunakan sebagai default untuk klaster DB baru. Ini penting khususnya untuk parameter yang sangat penting saat membuat basis data default untuk sebuah klaster DB, seperti set karakter untuk basis data default yang ditentukan oleh parameter character_set_database. Anda dapat menggunakan pilihan Grup Parameter dari konsol Amazon Neptune atau perintah DijelaskanBClusterParameters(tindakan) untuk memverifikasi bahwa grup parameter klaster DB Anda telah dibuat atau diubah.

Permintaan

  • DBClusterParameterGroupName(di CLI:--db-cluster-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter klaster DB untuk dimodifikasi.

  • Parameters(di CLI:--parameters) —Diperlukan:Array dariParameterbenda.

    Daftar parameter dalam grup parameter klaster DB untuk dimodifikasi.

Respon

  • DBClusterParameterGroupName- String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter klaster.

    Kendala:

    • Harus huruf atau angka berisi 1 sampai 255 karakter.

    • Karakter pertamanya harus berupa huruf

    • Tidak boleh diakhiri dengan tanda hubung atau berisi dua tanda hubung yang berurutan

    catatan

    Nilai ini disimpan sebagai string huruf kecil.

Kesalahan

ResetDBParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:reset-db-parameter-group.

Memodifikasi parameter dari grup parameter DB ke mesin/nilai default sistem. Untuk mereset parameter tertentu, kirimkan daftar berikut ini: ParameterName dan ApplyMethod. Untuk mereset seluruh grup parameter DB, tentukan nama DBParameterGroup dan parameter ResetAllParameters. Ketika Anda mereset seluruh grup, parameter dinamis segera diperbarui dan parameter statis diatur ke pending-reboot untuk berlaku pada restart instans DB berikutnya atau permintaan RebootDBInstance

Permintaan

  • DBParameterGroupName(di CLI:--db-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter DB.

    Batasan:

    • Harus cocok dengan nama DB yang adaParameterGroup.

  • Parameters(di CLI:--parameters) - Array dariParameterbenda.

    Untuk mereset seluruh grup parameter DB, tentukan nama DBParameterGroup dan parameter ResetAllParameters. Untuk mereset parameter tertentu, kirimkan daftar berikut ini: ParameterName dan ApplyMethod. Maksimum 20 parameter dapat dimodifikasi dalam satu permintaan.

    Nilai yang Valid (untuk metode Penerapan): pending-reboot

  • ResetAllParameters(di CLI:--reset-all-parameters) - Boolean, tipe:boolean(nilai Boolean (true atau false)).

    Menentukan apakah (true) atau tidak (false) akan mereset semua parameter di grup parameter DB ke nilai defaultnya.

    Default: true

Respon

  • DBParameterGroupName- String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan nama grup parameter DB.

Kesalahan

ResetDBClusterParameterGroup(tindakan)

        YangAWSNama CLI untuk API ini adalah:reset-db-cluster-parameter-group.

Memodifikasi parameter dari grup parameter klaster DB ke nilai default. Untuk mereset parameter tertentu, kirimkan daftar berikut ini: ParameterName dan ApplyMethod. Untuk mereset seluruh grup parameter klaster DB, tentukan parameter DBClusterParameterGroupName dan ResetAllParameters.

Ketika Anda mereset seluruh grup, parameter dinamis segera diperbarui dan parameter statis diatur ke pending-reboot untuk berlaku pada restart instans DB berikutnya atau permintaan RebootDBInstance (tindakan) Anda harus menelepon RebootDBInstance (tindakan) untuk setiap instans DB di klaster DB Anda yang Anda ingin parameter statis diperbaruinya diterapkan.

Permintaan

  • DBClusterParameterGroupName(di CLI:--db-cluster-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter klaster DB untuk direset.

  • Parameters(di CLI:--parameters) - Array dariParameterbenda.

    Daftar nama parameter dalam grup parameter klaster DB untuk direset ke nilai default. Anda tidak dapat menggunakan parameter ini jika parameter ResetAllParameters diatur ke true.

  • ResetAllParameters(di CLI:--reset-all-parameters) - Boolean, tipe:boolean(nilai Boolean (true atau false)).

    Nilai yang diatur ke true untuk me-reset semua parameter dalam kelompok parameter klaster DB ke nilai defaultnya, dan false sebaliknya. Anda tidak dapat menggunakan parameter ini jika ada daftar nama parameter yang ditentukan untuk parameter Parameters.

Respon

  • DBClusterParameterGroupName- String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter klaster.

    Kendala:

    • Harus huruf atau angka berisi 1 sampai 255 karakter.

    • Karakter pertamanya harus berupa huruf

    • Tidak boleh diakhiri dengan tanda hubung atau berisi dua tanda hubung yang berurutan

    catatan

    Nilai ini disimpan sebagai string huruf kecil.

Kesalahan

DescribeDBParameters (tindakan)

        YangAWSNama CLI untuk API ini adalah:describe-db-parameters.

Mengembalikan daftar parameter detail untuk grup parameter DB khusus.

Permintaan

  • DBParameterGroupName(di CLI:--db-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter DB tertentu untuk mengembalikan detail.

    Batasan:

    • Jika disediakan, harus sesuai dengan nama DB yang adaParameterGroup.

  • Filters(di CLI:--filters) - Array dariFilterbenda.

    Parameter ini saat ini tidak didukung.

  • Marker(di CLI:--marker) - String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan DescribeDBParameters sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • MaxRecords(di CLI:--max-records) — sebuahIntegerOptional, dari jenis:integer(integer 32-bit yang ditandatangani).

    Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai MaxRecords yang ditentukan, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

    Default: 100

    Kendala: Minimal 20, maksimum 100.

  • Source(di CLI:--source) - String, tipe:string(string yang dikodekan UTF-8).

    Jenis parameter untuk dikembalikan.

    Default: Semua jenis parameter yang dikembalikan

    Nilai yang Valid: user | system | engine-default

Respon

  • Marker- String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • Parameters – Susunan objek Parameter.

    Daftar nilai Parameter (struktur).

Kesalahan

DijelaskanBParameterGroups(tindakan)

        YangAWSNama CLI untuk API ini adalah:describe-db-parameter-groups.

Mengembalikan daftar deskripsi DBParameterGroup. Jika DBParameterGroupName ditentukan, daftar hanya akan berisi deskripsi dari grup parameter DB yang ditentukan.

Permintaan

  • DBParameterGroupName(di CLI:--db-parameter-group-name) - String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter DB tertentu untuk mengembalikan detail.

    Batasan:

    • Jika disediakan, harus sesuai dengan nama DB yang adaClusterParameterGroup.

  • Filters(di CLI:--filters) - Array dariFilterbenda.

    Parameter ini saat ini tidak didukung.

  • Marker(di CLI:--marker) - String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan DescribeDBParameterGroups sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • MaxRecords(di CLI:--max-records) — sebuahIntegerOptional, dari jenis:integer(integer 32-bit yang ditandatangani).

    Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai MaxRecords yang ditentukan, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

    Default: 100

    Kendala: Minimal 20, maksimum 100.

Respon

  • DBParameterGroups – Susunan objek DBParameterGroup.

    Daftar instans DBParameterGroup(struktur).

  • Marker- String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

Kesalahan

DijelaskanBClusterParameters(tindakan)

        YangAWSNama CLI untuk API ini adalah:describe-db-cluster-parameters.

Mengembalikan daftar parameter detail untuk grup parameter kluster DB tertentu.

Permintaan

  • DBClusterParameterGroupName(di CLI:--db-cluster-parameter-group-name) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter klaster DB tertentu yang detail parameternya dikembalikan.

    Batasan:

    • Jika disediakan, harus sesuai dengan nama DB yang adaClusterParameterGroup.

  • Filters(di CLI:--filters) - Array dariFilterbenda.

    Parameter ini saat ini tidak didukung.

  • Marker(di CLI:--marker) - String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan DescribeDBClusterParameters sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • MaxRecords(di CLI:--max-records) — sebuahIntegerOptional, dari jenis:integer(integer 32-bit yang ditandatangani).

    Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai MaxRecords yang ditentukan, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

    Default: 100

    Kendala: Minimal 20, maksimum 100.

  • Source(di CLI:--source) - String, tipe:string(string yang dikodekan UTF-8).

    Nilai yang menunjukkan untuk mengembalikan hanya parameter untuk sumber tertentu. Sumber parameter dapat berupa engine, service, atau customer.

Respon

  • Marker- String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh deskripsiDB sebelumnyaClusterParameterspermintaan. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • Parameters – Susunan objek Parameter.

    Menyediakan daftar parameter untuk grup parameter klaster DB.

Kesalahan

DijelaskanBClusterParameterGroups(tindakan)

        YangAWSNama CLI untuk API ini adalah:describe-db-cluster-parameter-groups.

Mengembalikan daftar deskripsi DBClusterParameterGroup. Jika parameter DBClusterParameterGroupName ditentukan, daftar berisi hanya deskripsi grup parameter klaster DB yang ditentukan.

Permintaan

  • DBClusterParameterGroupName(di CLI:--db-cluster-parameter-group-name) - String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter klaster DB tertentu yang detailnya dikembalikan.

    Batasan:

    • Jika disediakan, harus sesuai dengan nama DB yang adaClusterParameterGroup.

  • Filters(di CLI:--filters) - Array dariFilterbenda.

    Parameter ini saat ini tidak didukung.

  • Marker(di CLI:--marker) - String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan DescribeDBClusterParameterGroups sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • MaxRecords(di CLI:--max-records) — sebuahIntegerOptional, dari jenis:integer(integer 32-bit yang ditandatangani).

    Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai MaxRecords yang ditentukan, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

    Default: 100

    Kendala: Minimal 20, maksimum 100.

Respon

  • DBClusterParameterGroups – Susunan objek DBClusterParameterGroup.

    Daftar grup parameter klaster DB.

  • Marker- String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan DescribeDBClusterParameterGroups sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

Kesalahan

DescribeEngineDefaultParameters(tindakan)

        YangAWSNama CLI untuk API ini adalah:describe-engine-default-parameters.

Mengembalikan mesin default dan informasi parameter sistem untuk mesin basis data tertentu.

Permintaan

  • DBParameterGroupFamily(di CLI:--db-parameter-group-family) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama keluarga grup parameter DB.

  • Filters(di CLI:--filters) - Array dariFilterbenda.

    Saat ini tidak didukung.

  • Marker(di CLI:--marker) - String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan DescribeEngineDefaultParameters sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • MaxRecords(di CLI:--max-records) — sebuahIntegerOptional, dari jenis:integer(integer 32-bit yang ditandatangani).

    Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai MaxRecords yang ditentukan, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

    Default: 100

    Kendala: Minimal 20, maksimum 100.

Respon

Berisi hasil pemanggilan yang berhasil dari tindakan DescribeEngineDefaultParameters(tindakan).

  • DBParameterGroupFamily- String, tipe:string(string yang dikodekan UTF-8).

    Menentukan nama keluarga grup parameter DB yang diterapkan parameter default mesin.

  • Marker- String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan EngineDefaults sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • Parameters – Susunan objek Parameter.

    Berisi daftar parameter default mesin.

DescribeEngineDefaultClusterParameters(tindakan)

        YangAWSNama CLI untuk API ini adalah:describe-engine-default-cluster-parameters.

Mengembalikan mesin default dan informasi parameter sistem untuk mesin basis data klaster.

Permintaan

  • DBParameterGroupFamily(di CLI:--db-parameter-group-family) —Diperlukan:String, tipe:string(string yang dikodekan UTF-8).

    Nama keluarga grup parameter klaster DB untuk mengembalikan informasi parameter mesin.

  • Filters(di CLI:--filters) - Array dariFilterbenda.

    Parameter ini saat ini tidak didukung.

  • Marker(di CLI:--marker) - String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan DescribeEngineDefaultClusterParameters sebelumnya. Jika parameter ini ditentukan, respon hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • MaxRecords(di CLI:--max-records) — sebuahIntegerOptional, dari jenis:integer(integer 32-bit yang ditandatangani).

    Jumlah maksimum catatan yang akan dikembalikan dalam respons. Jika lebih banyak catatan ada daripada nilai MaxRecords yang ditentukan, token pagination (pemberian nomor halaman) yang disebut penanda disertakan dalam respons sehingga hasil yang tersisa dapat diambil.

    Default: 100

    Kendala: Minimal 20, maksimum 100.

Respon

Berisi hasil pemanggilan yang berhasil dari tindakan DescribeEngineDefaultParameters(tindakan).

  • DBParameterGroupFamily- String, tipe:string(string yang dikodekan UTF-8).

    Menentukan nama keluarga grup parameter DB yang diterapkan parameter default mesin.

  • Marker- String, tipe:string(string yang dikodekan UTF-8).

    Token pagination opsional yang disediakan oleh permintaan EngineDefaults sebelumnya. Jika parameter ini ditentukan, respons hanya menyertakan catatan di luar penanda, hingga nilai yang ditentukan dengan MaxRecords.

  • Parameters – Susunan objek Parameter.

    Berisi daftar parameter default mesin.

Struktur:

Parameter (struktur)

Menentukan parameter.

Bidang

  • AllowedValues- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menentukan rentang nilai yang valid untuk parameter.

  • ApplyMethod— Ini adalahApplyMethod, dari jenis:string(string yang dikodekan UTF-8).

    Menunjukkan kapan harus menerapkan pembaruan parameter.

  • ApplyType- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menentukan mesin tipe parameter tertentu.

  • DataType- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menentukan tipe data yang valid untuk parameter.

  • Description- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan deskripsi parameter.

  • IsModifiable- Ini adalah Boolean, tipe:boolean(nilai Boolean (true atau false)).

    Menunjukkan apakah (true) atau tidak (false) parameter dapat dimodifikasi. Beberapa parameter memiliki implikasi keamanan atau operasional yang mencegahnya diubah.

  • MinimumEngineVersion- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Versi mesin paling awal yang parameternya dapat diterapkan.

  • ParameterName- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menentukan nama dari parameter.

  • ParameterValue- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menentukan nilai dari parameter.

  • Source- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menunjukkan sumber nilai parameter.

DBParameterGroup(struktur)

Berisi detail dari grup parameter Amazon Neptune DB.

Tipe data ini digunakan sebagai elemen respon dalam tindakan DijelaskanBParameterGroups(tindakan).

Bidang

  • DBParameterGroupArn- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Amazon Resource Name (ARN) untuk grup parameter DB.

  • DBParameterGroupFamily- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Memberikan nama keluarga grup parameter DB yang kompatibel dengan grup parameter DB ini.

  • DBParameterGroupName- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan nama grup parameter DB.

  • Description- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan deskripsi yang ditentukan pelanggan untuk grup parameter DB ini.

DBParameterGroup digunakan sebagai elemen respon untuk:

DBClusterParameterGroup(struktur)

Berisi detail dari grup parameter klaster Amazon Neptune DB.

Tipe data ini digunakan sebagai elemen respon dalam tindakan DijelaskanBClusterParameterGroups(tindakan).

Bidang

  • DBClusterParameterGroupArn- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Amazon Resource Name (ARN) untuk grup parameter klaster DB.

  • DBClusterParameterGroupName- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Memberikan nama grup parameter klaster DB.

  • DBParameterGroupFamily- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan nama keluarga grup parameter DB yang kompatibel dengan grup parameter klaster DB ini.

  • Description- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Menyediakan deskripsi yang ditentukan pelanggan untuk grup parameter klaster DB ini.

DBClusterParameterGroup digunakan sebagai elemen respon untuk:

DBParameterGroupStatus(struktur)

Status grup parameter DB..

Tipe data ini digunakan sebagai elemen respon dalam tindakan berikut:

Bidang

  • DBParameterGroupName- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Nama grup parameter DP.

  • ParameterApplyStatus- Ini adalah String, tipe:string(string yang dikodekan UTF-8).

    Status pembaruan parameter.