Neptune-Subnetz-API

Aktionen:

• CreateDBSubnetGroup (Aktion)

• DeleteDBSubnetGroup (Aktion)

• ModifyDBSubnetGroup (Aktion)

• DescribeDBSubnetGroups (Aktion)

Strukturen:

• Subnetz (Struktur)

• DBSubnetGroup (Struktur)

CreateDBSubnetGroup (Aktion)

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

Erstellt eine neue DB-Subnetzgruppe. DB-Subnetzgruppen müssen mindestens ein Subnetz in mindestens zwei AZs in der Amazon-Region enthalten.

Anforderung

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

  Die Beschreibung für die Datenbank-Subnetzgruppe.

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

  Der Name für die DB-Subnetzgruppe. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.

  Einschränkungen: Darf nicht mehr als 255 Buchstaben, Ziffern, Punkte, Unterstriche, Leerzeichen und Bindestriche enthalten. Der Name darf nicht default sein.

  Beispiel: mySubnetgroup

• SubnetIds  (in der CLI: --subnet-ids) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die EC2-Subnetz-IDs für die DB-Subnetzgruppe.

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

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

Antwort

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

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

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

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

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

  Stellt die Beschreibung der DB-Subnetzgruppe bereit.

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

  Der Name der DB-Subnetzgruppe.

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

  Stellt den Status der DB-Subnetzgruppe bereit.

• Subnets – Ein Array mit Subnetz-Objekten.

  Enthält eine Liste von Subnetz (Struktur)-Elementen.

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

  Stellt die VpcId der DB-Subnetzgruppe bereit.

Fehler

• DBSubnetGroupAlreadyExistsFault

• DBSubnetGroupQuotaExceededFault

• DBSubnetQuotaExceededFault

• DBSubnetGroupDoesNotCoverEnoughAZs

• InvalidSubnet

DeleteDBSubnetGroup (Aktion)

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

Löscht eine DB-Subnetzgruppe.

Anmerkung

Die angegebene Datenbanksubnetzgruppe muss nicht mit beliebigen DB-Instances verknüpft werden.

Anforderung

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

  Der Name der zu löschenden Datenbanksubnetzgruppe.

  Anmerkung

  Sie können die Standardsubnetzgruppe nicht löschen.

  Einschränkungen:

  Einschränkungen: Der Wert muss mit dem Namen einer vorhandenen DBSubnetGroup übereinstimmen. Der Name darf nicht default sein.

  Beispiel: mySubnetgroup

Antwort

• Keine Antwortparameter.

Fehler

• InvalidDBSubnetGroupStateFault

• InvalidDBSubnetStateFault

• DBSubnetGroupNotFoundFault

ModifyDBSubnetGroup (Aktion)

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

Ändert eine vorhandene DB-Subnetzgruppe. DB-Subnetzgruppen müssen mindestens ein Subnetz in mindestens zwei AZs in der Amazon-Region enthalten.

Anforderung

• DBSubnetGroupDescription  (in der CLI: --db-subnet-group-description) – eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die Beschreibung für die Datenbank-Subnetzgruppe.

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

  Der Name für die DB-Subnetzgruppe. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert. Sie können die Standardsubnetzgruppe nicht ändern.

  Einschränkungen: Der Wert muss mit dem Namen einer vorhandenen DBSubnetGroup übereinstimmen. Der Name darf nicht default sein.

  Beispiel: mySubnetgroup

• SubnetIds  (in der CLI: --subnet-ids) – Erforderlich: eine Zeichenfolge vom Typ string (UTF-8-kodierte Zeichenfolge).

  Die EC2-Subnetz-IDs für die DB-Subnetzgruppe.

Antwort

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

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

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

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

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

  Stellt die Beschreibung der DB-Subnetzgruppe bereit.

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

  Der Name der DB-Subnetzgruppe.

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

  Stellt den Status der DB-Subnetzgruppe bereit.

• Subnets – Ein Array mit Subnetz-Objekten.

  Enthält eine Liste von Subnetz (Struktur)-Elementen.

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

  Stellt die VpcId der DB-Subnetzgruppe bereit.

Fehler

• DBSubnetGroupNotFoundFault

• DBSubnetQuotaExceededFault

• SubnetAlreadyInUse

• DBSubnetGroupDoesNotCoverEnoughAZs

• InvalidSubnet

DescribeDBSubnetGroups (Aktion)

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

Gibt eine Liste von DBSubnetGroup-Beschreibungen zurück. Wenn ein DBSubnetGroupName angegeben wurde, enthält die Liste nur die Beschreibungen der angegebenen DBSubnetGroup.

Eine Übersicht über CIDR-Bereiche finden Sie im Wikipedia-Tutorial.

Anforderung

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

  Der Name der DB-Subnetzgruppe, deren Details Sie anzeigen möchten.

• 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 optionaler Paginierungs-Token, der von einer vorherigen DescribeDBSubnetGroups-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) – IntegerOptional-Wert vom Typ integer (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

• DBSubnetGroups – Ein Array mit DBSubnetGroup-Objekten.

  Eine Liste der DBSubnetGroup (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

• DBSubnetGroupNotFoundFault

Strukturen:

Subnetz (Struktur)

Gibt ein Subnetz an.

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

Felder

• SubnetAvailabilityZone – Dies ist ein AvailabilityZone-Objekt.

  Gibt die EC2-Availability Zone an, in der sich das Subnetz befindet.

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

  Gibt die Kennung des Subnetzes an.

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

  Gibt den Status des Subnetzes an.

DBSubnetGroup (Struktur)

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

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

Felder

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

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

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

  Stellt die Beschreibung der DB-Subnetzgruppe bereit.

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

  Der Name der DB-Subnetzgruppe.

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

  Stellt den Status der DB-Subnetzgruppe bereit.

• Subnets – Dies ist ein Array von Subnetz-Objekten.

  Enthält eine Liste von Subnetz (Struktur)-Elementen.

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

  Stellt die VpcId der DB-Subnetzgruppe bereit.

DBSubnetGroup wird als Antwortelement verwendet für:

• CreateDBSubnetGroup

• ModifyDBSubnetGroup