Neptune-Parameter-API - Amazon Neptune
DBParameterGruppe kopierenKopieren DBCluster ParameterGroupDBParameterGruppe erstellenErstellen DBCluster ParameterGroupDBParameterGruppe löschenLöschen DBCluster ParameterGroupDBParameterGruppe ändernModifizieren DBCluster ParameterGroupDBParameterGruppe zurücksetzenZurücksetzen DBCluster ParameterGroupBeschreiben DBParametersBeschreiben Sie DBParameter GruppenBeschreiben Sie die DBCluster ParameterBeschreiben DBCluster ParameterGroupsDescribeEngineDefaultParametersDescribeEngineDefaultClusterParameters________________________ParameterDBParameterGruppeDBClusterParameterGroupDBParameterGroupStatus

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Neptune-Parameter-API

Aktionen:

Strukturen:

DBParameterGruppe kopieren (Aktion)

        Der AWS CLI-Name für diese API lautet:copy-db-parameter-group.

Kopiert die angegebene DB-Parametergruppe.

Anforderung

  • SourceDBParameterGroupIdentifier  (in der CLI: --source-db-parameter-group-identifier) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die ID oder der ARN der Quell-DB-Parametergruppe. Weitere Informationen zum Erstellen eines ARN finden Sie unter Erstellen eines Amazon-Ressourcennamens (ARN).

    Einschränkungen:

    • Es ist eine gültige DB-Parametergruppe erforderlich.

    • Es ist eine gültige ID für die DB-Parametergruppe erforderlich, z. B. my-db-param-group, oder ein gültiger ARN.

  • Tags  (in der CLI: --tags) –  Ein Array von Markierung Objekten.

    Die Tags, die der kopierten DB-Parametergruppe zugewiesen werden.

  • TargetDBParameterGroupDescription  (in der CLI: --target-db-parameter-group-description) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Beschreibung der kopierten DB-Parametergruppe.

  • TargetDBParameterGroupIdentifier  (in der CLI: --target-db-parameter-group-identifier) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die ID der kopierten DB-Parametergruppe.

    Einschränkungen:

    • Kann nicht Null, leer oder negativ sein.

    • Muss zwischen 1 und 255 Buchstaben, Ziffern oder Bindestriche enthalten.

    • Muss mit einem Buchstaben beginnen.

    • Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.

    Beispiel: my-db-parameter-group

Antwort

Enthält die Details einer Amazon Neptune-DB-Parametergruppe.

Dieser Datentyp wird als Antwortelement in der Aktion DBParameterGruppen beschreiben (Aktion) verwendet.

  • DBParameterGroupArn – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Amazon-Ressourcenname (ARN) für die DB-Parametergruppe.

  • DBParameterGroupFamily – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppenfamilie an, mit der diese DB-Parametergruppe kompatibel ist.

  • DBParameterGroupName – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppe an.

  • Description – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt die vom Kunden angegebene Beschreibung für diese DB-Parametergruppe an.

Fehler

Kopieren DBCluster ParameterGroup (Aktion)

        Der AWS CLI-Name für diese API lautet:copy-db-cluster-parameter-group.

Kopiert die angegebene DB-Cluster-Parametergruppe.

Anforderung

  • SourceDBClusterParameterGroupIdentifier  (in der CLI: --source-db-cluster-parameter-group-identifier) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die ID oder der Amazon-Ressourcenname (ARN) für die Quell-DB-Cluster-Parametergruppe. Weitere Informationen zum Erstellen eines ARN finden Sie unter Erstellen eines Amazon-Ressourcennamens (ARN).

    Einschränkungen:

    • Es ist eine gültige DB-Cluster-Parametergruppe erforderlich.

    • Wenn sich die Quell-DB-Cluster-Parametergruppe und die Kopie in derselben Amazon-Region befinden, geben Sie eine gültige DB-Parametergruppen-ID (z. B. my-db-cluster-param-group) oder einen gültigen ARN an.

    • Wenn sich die Quell-DB-Parametergruppe und die Kopie in unterschiedlichen Amazon-Regionen befinden, geben Sie einen gültigen DB-Cluster-Parametergruppen-ARN an, z. B. arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

  • Tags  (in der CLI: --tags) –  Ein Array von Markierung Objekten.

    Die Tags, die der kopierten DB-Cluster-Parametergruppe zugewiesen werden.

  • TargetDBClusterParameterGroupDescription  (in der CLI: --target-db-cluster-parameter-group-description) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Beschreibung der kopierten DB-Cluster-Parametergruppe.

  • TargetDBClusterParameterGroupIdentifier  (in der CLI: --target-db-cluster-parameter-group-identifier) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die ID der kopierten DB-Cluster-Parametergruppe.

    Einschränkungen:

    • Kann nicht Null, leer oder negativ sein.

    • Muss zwischen 1 und 255 Buchstaben, Ziffern oder Bindestriche enthalten.

    • Muss mit einem Buchstaben beginnen

    • Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten

    Beispiel: my-cluster-param-group1

Antwort

Enthält die Details einer Amazon Neptune-DB-Cluster-Parametergruppe.

Dieser Datentyp wird als Antwortelement in der Aktion Beschreiben Sie DBCluster ParameterGroups (Aktion) verwendet.

  • DBClusterParameterGroupArn – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Amazon-Ressourcenname (ARN) für die DB-Cluster-Parametergruppe.

  • DBClusterParameterGroupName – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Cluster-Parametergruppe an.

  • DBParameterGroupFamily – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppenfamilie an, mit der diese DB-Cluster-Parametergruppe kompatibel ist.

  • Description – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt die vom Kunden angegebene Beschreibung für diese DB-Cluster-Parametergruppe an.

Fehler

DBParameterGruppe erstellen (Aktion)

        Der AWS CLI-Name für diese API lautet:create-db-parameter-group.

Erstellt eine neue DB-Parametergruppe.

Zu Beginn wird eine DB-Parametergruppe mit den Standardparametern für die Datenbank-Engine erstellt, die von der DB-Instance verwendet wird. Um benutzerdefinierte Werte für einen der Parameter bereitzustellen, müssen Sie die Gruppe ändern, nachdem Sie sie mit Modify DBParameter Group erstellt haben. Nachdem Sie eine DB-Parametergruppe erstellt haben, müssen Sie sie mithilfe von Modify mit Ihrer DB-Instance verknüpfenDBInstance. Wenn Sie eine neue DB-Parametergruppe einer DB-Instance zuordnen, die gerade ausgeführt wird, müssen Sie die DB-Instance ohne Failover für die neue DB-Parametergruppe und die zugehörigen Einstellungen neu starten, damit die Änderungen wirksam werden.

Wichtig

Nach der Erstellung einer DB-Parametergruppe sollten Sie mindestens fünf Minuten warten, bevor Sie die erste DB-Instance erstellen, die diese DB-Parametergruppe als Standardparametergruppe verwendet. So kann der Erstellvorgang in Amazon Neptune zunächst vollständig abgeschlossen werden, bevor die Parametergruppe als Standard für eine neue DB-Instance verwendet wird. Dies ist besonders wichtig für Parameter, die kritisch für das Erstellen der Standard-Datenbank für eine DB-Instance sind, solche wie der Zeichensatz für die Standard-Datenbank über den Parameter character_set_database. Sie können die Option Parameter Groups der Amazon Neptune Neptune-Konsole oder den DBParameters Befehl Describe verwenden, um zu überprüfen, ob Ihre DB-Parametergruppe erstellt oder geändert wurde.

Anforderung

  • DBParameterGroupFamily  (in der CLI: --db-parameter-group-family) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Parametergruppenfamilie. Eine DB-Parametergruppe kann nur einer einzigen DB-Parametergruppenfamilie zugeordnet und nur auf eine DB-Instance angewendet werden, in der eine Datenbank-Engine ausgeführt wird; deren Version muss mit dieser DB-Parametergruppenfamilie kompatibel sein.

  • DBParameterGroupName  (in der CLI: --db-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Parametergruppe.

    Einschränkungen:

    • Muss zwischen 1 und 255 Buchstaben, Zahlen oder Bindestriche enthalten.

    • Muss mit einem Buchstaben beginnen

    • Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten

    Anmerkung

    Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.

  • Description  (in der CLI: --description) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die Beschreibung für die DB-Parametergruppe.

  • Tags  (in der CLI: --tags) –  Ein Array von Markierung Objekten.

    Die Tags, die der neuen DB-Parametergruppe zugewiesen werden.

Antwort

Enthält die Details einer Amazon Neptune-DB-Parametergruppe.

Dieser Datentyp wird als Antwortelement in der Aktion DBParameterGruppen beschreiben (Aktion) verwendet.

  • DBParameterGroupArn – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Amazon-Ressourcenname (ARN) für die DB-Parametergruppe.

  • DBParameterGroupFamily – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppenfamilie an, mit der diese DB-Parametergruppe kompatibel ist.

  • DBParameterGroupName – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppe an.

  • Description – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt die vom Kunden angegebene Beschreibung für diese DB-Parametergruppe an.

Fehler

Erstellen DBCluster ParameterGroup (Aktion)

        Der AWS CLI-Name für diese API lautet:create-db-cluster-parameter-group.

Erstellt eine neue DB-Cluster-Parametergruppe.

Parameter in einer DB-Cluster-Parametergruppe gelten für alle Instances in einem DB-Cluster.

Zu Beginn wird eine DB-Cluster-Parametergruppe mit den Standardparametern für die Datenbank-Engine erstellt, die von den Instances im DB-Cluster verwendet wird. Wenn Sie benutzerdefinierte Werte für die Parameter bereitstellen möchten, müssen Sie die Gruppe nach der Erstellung mithilfe von Ändern DBCluster ParameterGroup (Aktion) ändern. Sobald Sie eine DB-Cluster-Parametergruppe erstellt haben, müssen Sie sie mithilfe von Ändern DBCluster (Aktion) Ihrem DB-Cluster zuordnen. Wenn Sie eine neue DB-Cluster-Parametergruppe zu einem DB-Cluster zuordnen, der gerade ausgeführt wird, müssen Sie die DB-Instances im DB-Cluster ohne Failover für die neue DB-Cluster-Parametergruppe und die zugehörigen Einstellungen neu starten, damit die Änderungen wirksam werden.

Wichtig

Nachdem Sie eine DB-Cluster-Parametergruppe erstellt haben, sollten Sie mindestens fünf Minuten warten, bevor Sie das erste DB-Cluster erstellen, das diese DB-Cluster-Parametergruppe als Standardparametergruppe verwendet. So kann der Erstellvorgang in Amazon Neptune zunächst vollständig abgeschlossen werden, bevor die DB-Cluster-Parametergruppe als Standard für einen neuen DB-Cluster verwendet wird. Dies gilt insbesondere für Parameter, die beim Erstellen der Standarddatenbank für einen DB-Cluster wichtig sind (z. B. der Zeichensatz für die Standarddatenbank, der über den Parameter character_set_database definiert wird). Mit der Option Parameter Groups (Parametergruppen) der Amazon Neptune-Konsole oder dem Befehl Beschreiben Sie die DBCluster Parameter (Aktion) überprüfen Sie, ob die DB-Cluster-Parametergruppe erstellt oder geändert wurde.

Anforderung

  • DBClusterParameterGroupName  (in der CLI: --db-cluster-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Cluster-Parametergruppe.

    Einschränkungen:

    • Muss mit dem Namen einer vorhandenen Datei übereinstimmen DBClusterParameterGroup.

    Anmerkung

    Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.

  • DBParameterGroupFamily  (in der CLI: --db-parameter-group-family) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Cluster-Parametergruppenfamilie. Eine DB-Cluster-Parametergruppe kann nur einer einzigen DB-Cluster-Parametergruppenfamilie zugeordnet und nur auf einen DB-Cluster angewendet werden, in dem eine Datenbank-Engine ausgeführt wird; deren Version muss mit dieser DB-Cluster-Parametergruppenfamilie kompatibel sein.

  • Description  (in der CLI: --description) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die Beschreibung der DB-Cluster-Parametergruppe.

  • Tags  (in der CLI: --tags) –  Ein Array von Markierung Objekten.

    Die Tags, die der neuen DB-Cluster-Parametergruppe zugewiesen werden.

Antwort

Enthält die Details einer Amazon Neptune-DB-Cluster-Parametergruppe.

Dieser Datentyp wird als Antwortelement in der Aktion Beschreiben Sie DBCluster ParameterGroups (Aktion) verwendet.

  • DBClusterParameterGroupArn – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Amazon-Ressourcenname (ARN) für die DB-Cluster-Parametergruppe.

  • DBClusterParameterGroupName – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Cluster-Parametergruppe an.

  • DBParameterGroupFamily – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppenfamilie an, mit der diese DB-Cluster-Parametergruppe kompatibel ist.

  • Description – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt die vom Kunden angegebene Beschreibung für diese DB-Cluster-Parametergruppe an.

Fehler

DBParameterGruppe löschen (Aktion)

        Der AWS CLI-Name für diese API lautet:delete-db-parameter-group.

Löscht eine angegebene DBParameter Gruppe. Die zu löschende DBParameter Gruppe kann keiner DB-Instance zugeordnet werden.

Anforderung

  • DBParameterGroupName  (in der CLI: --db-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Parametergruppe.

    Einschränkungen:

    • Muss dem Namen einer vorhandenen DB-Parametergruppe entsprechen.

    • Eine Standard-DB-Parametergruppe kann nicht gelöscht werden.

    • Kann keinen DB-Instances zugeordnet werden.

Antwort

  • Keine Antwortparameter.

Fehler

Löschen DBCluster ParameterGroup (Aktion)

        Der AWS CLI-Name für diese API lautet:delete-db-cluster-parameter-group.

Löscht eine angegebene DB-Cluster-Parametergruppe. Die zu löschende DB-Cluster-Parametergruppe kann keinen DB-Clustern zugeordnet werden.

Anforderung

  • DBClusterParameterGroupName  (in der CLI: --db-cluster-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Cluster-Parametergruppe.

    Einschränkungen:

    • Muss dem Namen einer vorhandenen DB-Cluster-Parametergruppe entsprechen.

    • Eine Standard-DB-Cluster-Parametergruppe kann nicht gelöscht werden.

    • Kann keinen DB-Clustern zugeordnet werden.

Antwort

  • Keine Antwortparameter.

Fehler

DBParameterGruppe ändern (Aktion)

        Der AWS CLI-Name für diese API lautet:modify-db-parameter-group.

Ändert die Parameter einer DB-Parametergruppe. Wenn Sie mehr als einen Parameter ändern möchten, übergeben Sie eine Liste mit den folgenden Optionen: ParameterName, ParameterValue und ApplyMethod. Pro Anforderung können maximal 20 Parameter geändert werden.

Anmerkung

Änderungen an dynamischen Parametern werden sofort angewendet. Änderungen an statischen Parametern erfordern einen Neustart ohne Failover auf die DB-Instance, die der Parametergruppe zugeordnet ist. Erst danach werden die Änderungen wirksam.

Wichtig

Nachdem Sie eine DB-Parametergruppe geändert haben, sollten Sie mindestens fünf Minuten warten, bevor Sie die erste DB-Instance erstellen, die diese DB-Parametergruppe als Standardparametergruppe verwendet. So kann der Änderungsvorgang in Amazon Neptune zunächst vollständig abgeschlossen werden, bevor die Parametergruppe als Standard für eine neue DB-Instance verwendet wird. Dies ist besonders wichtig für Parameter, die kritisch für das Erstellen der Standard-Datenbank für eine DB-Instance sind, solche wie der Zeichensatz für die Standard-Datenbank über den Parameter character_set_database. Sie können die Option Parameter Groups der Amazon Neptune Neptune-Konsole oder den DBParameters Befehl Describe verwenden, um zu überprüfen, ob Ihre DB-Parametergruppe erstellt oder geändert wurde.

Anforderung

  • DBParameterGroupName  (in der CLI: --db-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Parametergruppe.

    Einschränkungen:

    • Falls angegeben, muss sie mit dem Namen einer vorhandenen DBParameter Gruppe übereinstimmen.

  • Parameters  (in der CLI: --parameters) – Erforderlich: Ein Array von Parameter-Objekten.

    Ein Array von Parameternamen, Werten und der Anwendungsmethode für die Parameteraktualisierung. Es muss mindestens ein Name, ein Wert und eine Anwendungsmethode für den Parameter angegeben werden; nachfolgende Argumente sind optional. Pro Anforderung können maximal 20 Parameter geändert werden.

    Gültige Werte (für die Anwendungsmethode): immediate | pending-reboot

    Anmerkung

    Den Wert "immediate" können Sie nur mit dynamischen Parametern verwenden. Den Wert "pending-reboot" können Sie für dynamische und statische Parameter verwenden; die Änderungen werden beim Neustart der DB-Instance ohne Failover wirksam.

Antwort

  • DBParameterGroupName – eine Zeichenfolge vom Typ: string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppe an.

Fehler

Ändern DBCluster ParameterGroup (Aktion)

        Der AWS CLI-Name für diese API lautet:modify-db-cluster-parameter-group.

Ändert die Parameter einer DB-Cluster-Parametergruppe. Wenn Sie mehr als einen Parameter ändern möchten, übergeben Sie eine Liste mit den folgenden Optionen: ParameterName, ParameterValue und ApplyMethod. Pro Anforderung können maximal 20 Parameter geändert werden.

Anmerkung

Änderungen an dynamischen Parametern werden sofort angewendet. Änderungen an statischen Parametern erfordern einen Neustart ohne Failover auf den DB-Cluster, der der Parametergruppe zugeordnet ist. Erst danach werden die Änderungen wirksam.

Wichtig

Nachdem Sie eine DB-Cluster-Parametergruppe erstellt haben, sollten Sie mindestens fünf Minuten warten, bevor Sie das erste DB-Cluster erstellen, das diese DB-Cluster-Parametergruppe als Standardparametergruppe verwendet. So kann der Erstellvorgang in Amazon Neptune zunächst vollständig abgeschlossen werden, bevor die Parametergruppe als Standard für einen neuen DB-Cluster verwendet wird. Dies gilt insbesondere für Parameter, die beim Erstellen der Standarddatenbank für einen DB-Cluster wichtig sind (z. B. der Zeichensatz für die Standarddatenbank, der über den Parameter character_set_database definiert wird). Mit der Option Parameter Groups (Parametergruppen) der Amazon Neptune-Konsole oder dem Befehl Beschreiben Sie die DBCluster Parameter (Aktion) überprüfen Sie, ob die DB-Cluster-Parametergruppe erstellt oder geändert wurde.

Anforderung

  • DBClusterParameterGroupName  (in der CLI: --db-cluster-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der zu ändernden DB-Cluster-Parametergruppe.

  • Parameters  (in der CLI: --parameters) – Erforderlich: Ein Array von Parameter-Objekten.

    Eine Liste der Parameter in der zu ändernden DB-Cluster-Parametergruppe.

Antwort

  • DBClusterParameterGroupName – eine Zeichenfolge vom Typ: string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Cluster-Parametergruppe.

    Einschränkungen:

    • Muss 1 bis 255 Buchstaben oder Zahlen enthalten.

    • Muss mit einem Buchstaben beginnen

    • Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten

    Anmerkung

    Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.

Fehler

DBParameterGruppe zurücksetzen (Aktion)

        Der AWS CLI-Name für diese API lautet:reset-db-parameter-group.

Setzt die Parameter einer DB-Parametergruppe auf die Standardwerte der Engine/des Systems zurück. Wenn Sie bestimmte Parameter zurücksetzen möchten, geben Sie eine Liste mit folgenden Optionen an: ParameterName und ApplyMethod. Wenn Sie die gesamte DB-Parametergruppe zurücksetzen möchten, geben Sie den Namen der DBParameterGroup und die ResetAllParameters-Parameter an. Wenn Sie die gesamte Gruppe zurücksetzen, werden dynamische Parameter sofort aktualisiert und statische Parameter auf pending-reboot gesetzt, damit sie beim nächsten Neustart der DB-Instance oder bei der RebootDBInstance-Anforderung wirksam werden.

Anforderung

  • DBParameterGroupName  (in der CLI: --db-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Parametergruppe.

    Einschränkungen:

    • Muss mit dem Namen einer vorhandenen DBParameter Gruppe übereinstimmen.

  • Parameters  (in der CLI: --parameters) –  Ein Array von Parameter Objekten.

    Wenn Sie die gesamte DB-Parametergruppe zurücksetzen möchten, geben Sie den Namen der DBParameterGroup und die ResetAllParameters-Parameter an. Wenn Sie bestimmte Parameter zurücksetzen möchten, geben Sie eine Liste mit folgenden Optionen an: ParameterName und ApplyMethod. Pro Anforderung können maximal 20 Parameter geändert werden.

    Gültige Werte (Anwendungsmethode): pending-reboot

  • ResetAllParameters  (in der CLI: --reset-all-parameters) – boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

    Gibt an, ob alle Parameter in der DB-Parametergruppe auf ihre Standardwerte zurückgesetzt werden sollen oder nicht (true oder false).

    Standard: true

Antwort

  • DBParameterGroupName – eine Zeichenfolge vom Typ: string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppe an.

Fehler

Zurücksetzen DBCluster ParameterGroup (Aktion)

        Der AWS CLI-Name für diese API lautet:reset-db-cluster-parameter-group.

Setzt die Parameter einer DB-Cluster-Parametergruppe auf die Standardwerte zurück. Wenn Sie bestimmte Parameter zurücksetzen möchten, übergeben Sie eine Liste mit folgenden Optionen: ParameterName und ApplyMethod. Wenn Sie die gesamte DB-Cluster-Parametergruppe zurücksetzen möchten, geben Sie den Namen der DBClusterParameterGroupName und die ResetAllParameters-Parameter an.

Wenn Sie die gesamte Gruppe zurücksetzen, werden dynamische Parameter sofort aktualisiert und statische Parameter auf pending-reboot gesetzt, damit sie beim nächsten Neustart der DB-Instance oder bei der Neustart DBInstance (Aktion)-Anforderung wirksam werden. Sie müssen Neustart DBInstance (Aktion) für alle DB-Instances in Ihrem DB-Cluster aufrufen, auf die der aktualisierte statische Parameter angewendet werden soll.

Anforderung

  • DBClusterParameterGroupName  (in der CLI: --db-cluster-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der zurückzusetzenden DB-Cluster-Parametergruppe.

  • Parameters  (in der CLI: --parameters) –  Ein Array von Parameter Objekten.

    Eine Liste von Parameternamen in der DB-Cluster-Parametergruppe, die auf ihre Standardwerte zurücksetzt werden soll. Sie können den Parameter nicht verwenden, wenn der Parameter ResetAllParameters auf true festgelegt ist.

  • ResetAllParameters  (in der CLI: --reset-all-parameters) – boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

    Dieser Wert ist auf true festgelegt, wenn alle Parameter in der DB-Cluster-Parametergruppe auf ihre Standardwerte zurückgesetzt werden sollen, und andernfalls auf false. Diesen Parameter können Sie nicht verwenden, wenn es eine Liste von Parameternamen für Parameters gibt.

Antwort

  • DBClusterParameterGroupName – eine Zeichenfolge vom Typ: string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Cluster-Parametergruppe.

    Einschränkungen:

    • Muss 1 bis 255 Buchstaben oder Zahlen enthalten.

    • Muss mit einem Buchstaben beginnen

    • Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten

    Anmerkung

    Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.

Fehler

Beschreiben Sie DBParameters (Aktion)

        Der AWS CLI-Name für diese API lautet:describe-db-parameters.

Gibt die detaillierte Parameterliste für eine bestimmte DB-Parametergruppe zurück.

Anforderung

  • DBParameterGroupName  (in der CLI: --db-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name einer bestimmten DB-Parametergruppe, deren Details zurückgegeben werden sollen.

    Einschränkungen:

    • Falls angegeben, muss er mit dem Namen einer vorhandenen DBParameter Gruppe übereinstimmen.

  • Filters  (in der CLI: --filters) –  Ein Array von Filter Objekten.

    Dieser Parameter wird derzeit nicht unterstützt.

  • Marker  (in der CLI: --marker) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das von einer vorherigen DescribeDBParameters-Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • MaxRecords(in der CLI:--max-records) — ein IntegerOptional, vom Typ: integer (eine 32-Bit-Ganzzahl mit Vorzeichen).

    Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehrere Datensätze vorhanden sind, als der Wert MaxRecords angibt, ist ein Paginierungstoken mit dem Namen einer Markierung in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.

    Standard: 100

    Einschränkungen: Mindestwert 20, Höchstwert 100.

  • Source  (in der CLI: --source) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die Parametertypen, die zurückgegeben werden sollen.

    Standardmäßig werden alle Parametertypen zurückgegeben.

    Zulässige Werte: user | system | engine-default

Antwort

  • Marker – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • Parameters – Ein Array mit Parameter-Objekten.

    Eine Liste der Parameter (Struktur)-Werte-

Fehler

DBParameterGruppen beschreiben (Aktion)

        Der AWS CLI-Name für diese API lautet:describe-db-parameter-groups.

Gibt eine Liste von DBParameterGroup-Beschreibungen zurück. Wenn ein DBParameterGroupName angegeben wurde, enthält die Liste nur die Beschreibung der angegebenen DB-Parametergruppe.

Anforderung

  • DBParameterGroupName  (in der CLI: --db-parameter-group-name) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name einer bestimmten DB-Parametergruppe, deren Details zurückgegeben werden sollen.

    Einschränkungen:

    • Falls angegeben, muss er mit dem Namen einer vorhandenen Datei übereinstimmen DBClusterParameterGroup.

  • Filters  (in der CLI: --filters) –  Ein Array von Filter Objekten.

    Dieser Parameter wird derzeit nicht unterstützt.

  • Marker  (in der CLI: --marker) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das von einer vorherigen DescribeDBParameterGroups-Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • MaxRecords(in der CLI:--max-records) — ein IntegerOptional, vom Typ: integer (eine 32-Bit-Ganzzahl mit Vorzeichen).

    Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehrere Datensätze vorhanden sind, als der Wert MaxRecords angibt, ist ein Paginierungstoken mit dem Namen einer Markierung in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.

    Standard: 100

    Einschränkungen: Mindestwert 20, Höchstwert 100.

Antwort

  • DBParameterGroups – Ein Array mit DBParameterGruppe-Objekten.

    Eine Liste der DBParameterGruppe (Struktur)-Instances.

  • Marker – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das von einer vorherigen Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

Fehler

Beschreiben Sie die DBCluster Parameter (Aktion)

        Der AWS CLI-Name für diese API lautet:describe-db-cluster-parameters.

Gibt die detaillierte Parameterliste für eine bestimmte DB-Cluster-Parametergruppe zurück.

Anforderung

  • DBClusterParameterGroupName  (in der CLI: --db-cluster-parameter-group-name) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name einer bestimmten DB-Cluster-Parametergruppe, deren Parameterdetails zurückgegeben werden sollen.

    Einschränkungen:

    • Falls angegeben, muss er mit dem Namen einer vorhandenen Datei übereinstimmen DBClusterParameterGroup.

  • Filters  (in der CLI: --filters) –  Ein Array von Filter Objekten.

    Dieser Parameter wird derzeit nicht unterstützt.

  • Marker  (in der CLI: --marker) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das von einer vorherigen DescribeDBClusterParameters-Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • MaxRecords(in der CLI:--max-records) — ein IntegerOptional, vom Typ: integer (eine 32-Bit-Ganzzahl mit Vorzeichen).

    Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehrere Datensätze vorhanden sind, als der Wert MaxRecords angibt, ist ein Paginierungstoken mit dem Namen einer Markierung in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.

    Standard: 100

    Einschränkungen: Mindestwert 20, Höchstwert 100.

  • Source  (in der CLI: --source) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Dieser Wert gibt an, dass nur die Parameter für eine bestimmte Quelle zurückgegeben werden sollen. Parameterquellen können engine, service oder customer sein.

Antwort

  • Marker – eine Zeichenfolge vom Typ: string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das in einer früheren Anfrage zur Beschreibung der DBCluster Parameter bereitgestellt wurde. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • Parameters – Ein Array mit Parameter-Objekten.

    Gibt eine Liste der Parameter für die DB-Cluster-Parametergruppe zurück.

Fehler

Beschreiben Sie DBCluster ParameterGroups (Aktion)

        Der AWS CLI-Name für diese API lautet:describe-db-cluster-parameter-groups.

Gibt eine Liste von DBClusterParameterGroup-Beschreibungen zurück. Wenn ein DBClusterParameterGroupName-Parameter angegeben wurde, enthält die Liste nur die Beschreibung der angegebenen DB-Cluster-Parametergruppe.

Anforderung

  • DBClusterParameterGroupName  (in der CLI: --db-cluster-parameter-group-name) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name einer bestimmten DB-Cluster-Parametergruppe, deren Details zurückgegeben werden sollen.

    Einschränkungen:

    • Falls angegeben, muss er mit dem Namen einer vorhandenen Datei übereinstimmen DBClusterParameterGroup.

  • Filters  (in der CLI: --filters) –  Ein Array von Filter Objekten.

    Dieser Parameter wird derzeit nicht unterstützt.

  • Marker  (in der CLI: --marker) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das von einer vorherigen DescribeDBClusterParameterGroups-Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • MaxRecords(in der CLI:--max-records) — ein IntegerOptional, vom Typ: integer (eine 32-Bit-Ganzzahl mit Vorzeichen).

    Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehrere Datensätze vorhanden sind, als der Wert MaxRecords angibt, ist ein Paginierungstoken mit dem Namen einer Markierung in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.

    Standard: 100

    Einschränkungen: Mindestwert 20, Höchstwert 100.

Antwort

  • DBClusterParameterGroups – Ein Array mit DBClusterParameterGroup-Objekten.

    Eine Liste der DB-Cluster-Parametergruppen.

  • Marker – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das von einer vorherigen DescribeDBClusterParameterGroups-Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

Fehler

DescribeEngineDefaultParameters (Aktion)

        Der AWS CLI-Name für diese API lautet:describe-engine-default-parameters.

Gibt die Standard-Engine- und System-Parameterinformationen für die angegebene Datenbank-Engine zurück.

Anforderung

  • DBParameterGroupFamily  (in der CLI: --db-parameter-group-family) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Cluster-Parametergruppenfamilie.

  • Filters  (in der CLI: --filters) –  Ein Array von Filter Objekten.

    Wird derzeit nicht unterstützt.

  • Marker  (in der CLI: --marker) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das von einer vorherigen DescribeEngineDefaultParameters-Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • MaxRecords(in der CLI:--max-records) — ein IntegerOptional, vom Typ: integer (eine 32-Bit-Ganzzahl mit Vorzeichen).

    Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehrere Datensätze vorhanden sind, als der Wert MaxRecords angibt, ist ein Paginierungstoken mit dem Namen einer Markierung in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.

    Standard: 100

    Einschränkungen: Mindestwert 20, Höchstwert 100.

Antwort

Enthält das Ergebnis eines erfolgreichen Aufrufs der DescribeEngineDefaultParameters (Aktion)-Aktion.

  • DBParameterGroupFamily – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppenfamilie an, auf die die Standard-Parameter der Engine angewendet werden.

  • Marker – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das in einer früheren EngineDefaults Anfrage bereitgestellt wurde. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • Parameters – Ein Array mit Parameter-Objekten.

    Enthält eine Liste der Standardparameter der Engine.

DescribeEngineDefaultClusterParameters (Aktion)

        Der AWS CLI-Name für diese API lautet:describe-engine-default-cluster-parameters.

Gibt die Standard-Engine- und System-Parameterinformationen für die Cluster-Datenbank-Engine zurück.

Anforderung

  • DBParameterGroupFamily  (in der CLI: --db-parameter-group-family) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Cluster-Parametergruppenfamilie, für die Parameterinformationen der Engine zurückgegeben werden sollen.

  • Filters  (in der CLI: --filters) –  Ein Array von Filter Objekten.

    Dieser Parameter wird derzeit nicht unterstützt.

  • Marker  (in der CLI: --marker) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das von einer vorherigen DescribeEngineDefaultClusterParameters-Anforderung bereitgestellt wird. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • MaxRecords(in der CLI:--max-records) — ein IntegerOptional, vom Typ: integer (eine 32-Bit-Ganzzahl mit Vorzeichen).

    Die maximale Anzahl der in der Antwort zurückgegebenen Datensätze. Wenn mehrere Datensätze vorhanden sind, als der Wert MaxRecords angibt, ist ein Paginierungstoken mit dem Namen einer Markierung in der Antwort enthalten, sodass die verbleibenden Ergebnisse abgerufen werden können.

    Standard: 100

    Einschränkungen: Mindestwert 20, Höchstwert 100.

Antwort

Enthält das Ergebnis eines erfolgreichen Aufrufs der DescribeEngineDefaultParameters (Aktion)-Aktion.

  • DBParameterGroupFamily – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppenfamilie an, auf die die Standard-Parameter der Engine angewendet werden.

  • Marker – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Ein optionales Paginierungstoken, das in einer früheren EngineDefaults Anfrage bereitgestellt wurde. Wenn Sie diesen Parameter angeben, enthält die Antwort nur die Datensätze zwischen der Markierung und dem durch MaxRecords angegebenen Wert.

  • Parameters – Ein Array mit Parameter-Objekten.

    Enthält eine Liste der Standardparameter der Engine.

Strukturen:

Parameter (Struktur)

Gibt einen Parameter an.

Felder

  • AllowedValues – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den gültigen Wertebereich für den Parameter an.

  • ApplyMethod— Dies ist eine Zeichenfolge ApplyMethod vom Typ: string (eine UTF-8-kodierte Zeichenfolge).

    Gibt an, wann Parameteraktualisierungen angewendet werden können.

  • ApplyType – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Engine-spezifischen Parametertyp an.

  • DataType – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den gültigen Datentyp für den Parameter an.

  • Description – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Stellt eine Beschreibung des Parameters bereit.

  • IsModifiable – Dies ist ein boolescher Wert vom Typ boolean (boolescher Wert (wahr oder falsch)).

    Gibt an, ob der Parameter geändert werden kann oder nicht (true oder false). Einige Parameter wirken sich auf die Sicherheit oder die betrieblichen Abläufe aus und können nicht geändert werden.

  • MinimumEngineVersion – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Die älteste Engine-Version, auf die der Parameter angewendet werden kann.

  • ParameterName – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen des Parameters an.

  • ParameterValue – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Wert des Parameters an.

  • Source – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt die Quelle des Parameterwerts an.

DBParameterGruppe (Struktur)

Enthält die Details einer Amazon Neptune-DB-Parametergruppe.

Dieser Datentyp wird als Antwortelement in der Aktion DBParameterGruppen beschreiben (Aktion) verwendet.

Felder

  • DBParameterGroupArn – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Amazon-Ressourcenname (ARN) für die DB-Parametergruppe.

  • DBParameterGroupFamily – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppenfamilie an, mit der diese DB-Parametergruppe kompatibel ist.

  • DBParameterGroupName – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppe an.

  • Description – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt die vom Kunden angegebene Beschreibung für diese DB-Parametergruppe an.

DBParameterGroup wird als Antwortelement verwendet für:

DBClusterParameterGroup (Struktur)

Enthält die Details einer Amazon Neptune-DB-Cluster-Parametergruppe.

Dieser Datentyp wird als Antwortelement in der Aktion Beschreiben Sie DBCluster ParameterGroups (Aktion) verwendet.

Felder

  • DBClusterParameterGroupArn – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Amazon-Ressourcenname (ARN) für die DB-Cluster-Parametergruppe.

  • DBClusterParameterGroupName – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Cluster-Parametergruppe an.

  • DBParameterGroupFamily – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt den Namen der DB-Parametergruppenfamilie an, mit der diese DB-Cluster-Parametergruppe kompatibel ist.

  • Description – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Gibt die vom Kunden angegebene Beschreibung für diese DB-Cluster-Parametergruppe an.

DBClusterParameterGroup wird als Antwortelement verwendet für:

DBParameterGroupStatus (Struktur)

Der Status der DB-Parametergruppe.

Dieser Datentyp wird als Antwortelement in folgenden Aktionen verwendet:

Felder

  • DBParameterGroupName – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Name der DB-Parametergruppe.

  • ParameterApplyStatus – Dies ist eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

    Der Status von Parameteraktualisierungen.