API delle sottoreti Neptune

Operazioni:

• CreateDBSubnetGroup (operazione)

• DeleteDBSubnetGroup (operazione)

• ModifyDBSubnetGroup (operazione)

• DescribeDBSubnetGroups (operazione)

Strutture:

• Sottorete (struttura)

• DBSubnetGroup (struttura)

CreateDBSubnetGroup (operazione)

        Il nome AWS CLI per questa API è: create-db-subnet-group.

Crea un nuovo gruppo di sottoreti di database. I gruppi di sottoreti di database devono contenere almeno una sottorete in almeno due zone di disponibilità nella stessa regione Amazon.

Richiesta

• DBSubnetGroupDescription (nella CLI: --db-subnet-group-description): Obbligatorio: una stringa di tipo string (una stringa con codifica UTF-8).

  La descrizione per il gruppo di sottoreti DB.

• DBSubnetGroupName (nella CLI: --db-subnet-group-name): Obbligatorio: una stringa di tipo string (una stringa con codifica UTF-8).

  Il nome del gruppo di sottoreti DB. Questo valore è archiviato come stringa in caratteri minuscoli.

  Vincoli: devono contenere un massimo di 255 lettere, numeri, punti, trattini bassi, spazi o trattini. Non deve essere predefinito.

  Esempio: mySubnetgroup

• SubnetIds (nella CLI: --subnet-ids): Obbligatorio: una stringa di tipo string (una stringa con codifica UTF-8).

  ID di sottorete EC2 per il gruppo di sottoreti di database.

• Tags (nella CLI: --tags): un array di oggetti Tag.

  I tag da assegnare al nuovo gruppo di sottoreti di database.

Risposta

Contiene i dettagli di un gruppo di sottoreti di database Amazon Neptune.

Questo tipo di dati viene utilizzato come elemento di risposta nell'operazione DescribeDBSubnetGroups (operazione).

• DBSubnetGroupArn: una stringa di tipo string (una stringa con codifica UTF-8).

  Amazon Resource Name (ARN) per il gruppo di sottoreti di database.

• DBSubnetGroupDescription: una stringa di tipo string (una stringa con codifica UTF-8).

  Fornisce la descrizione del gruppo di sottoreti di database.

• DBSubnetGroupName: una stringa di tipo string (una stringa con codifica UTF-8).

  Il nome del gruppo di sottoreti DB.

• SubnetGroupStatus: una stringa di tipo string (una stringa con codifica UTF-8).

  Fornisce lo stato del gruppo di sottoreti di database.

• Subnets: una matrice di oggetti Sottorete.

  Include un elenco di elementi Sottorete (struttura).

• VpcId: una stringa di tipo string (una stringa con codifica UTF-8).

  Fornisce il VpcId del gruppo di sottoreti di database.

Errori

• DBSubnetGroupAlreadyExistsFault

• DBSubnetGroupQuotaExceededFault

• DBSubnetQuotaExceededFault

• DBSubnetGroupDoesNotCoverEnoughAZs

• InvalidSubnet

DeleteDBSubnetGroup (operazione)

        Il nome AWS CLI per questa API è: delete-db-subnet-group.

Eliminare un gruppo di sottoreti di database.

Nota

Il gruppo di sottoreti di database specificato non deve essere associato ad alcuna istanza database.

Richiesta

• DBSubnetGroupName (nella CLI: --db-subnet-group-name): Obbligatorio: una stringa di tipo string (una stringa con codifica UTF-8).

  Il nome del gruppo di sottoreti di database da eliminare.

  Nota

  Non è possibile eliminare il gruppo di sottoreti di default.

  Vincoli:

  Vincoli: deve corrispondere al nome di un oggetto DBSubnetGroup esistente. Non deve essere predefinito.

  Esempio: mySubnetgroup

Risposta

• Nessun parametro di risposta.

Errori

• InvalidDBSubnetGroupStateFault

• InvalidDBSubnetStateFault

• DBSubnetGroupNotFoundFault

ModifyDBSubnetGroup (operazione)

        Il nome AWS CLI per questa API è: modify-db-subnet-group.

Modifica un gruppo di sottoreti di database esistente. I gruppi di sottoreti di database devono contenere almeno una sottorete in almeno due zone di disponibilità nella stessa regione Amazon.

Richiesta

• DBSubnetGroupDescription (nella CLI: --db-subnet-group-description): una stringa di tipo string (una stringa con codifica UTF-8).

  La descrizione per il gruppo di sottoreti DB.

• DBSubnetGroupName (nella CLI: --db-subnet-group-name): Obbligatorio: una stringa di tipo string (una stringa con codifica UTF-8).

  Il nome del gruppo di sottoreti DB. Questo valore è archiviato come stringa in caratteri minuscoli. Non è possibile modificare il gruppo di sottoreti di default.

  Vincoli: deve corrispondere al nome di un oggetto DBSubnetGroup esistente. Non deve essere predefinito.

  Esempio: mySubnetgroup

• SubnetIds (nella CLI: --subnet-ids): Obbligatorio: una stringa di tipo string (una stringa con codifica UTF-8).

  ID di sottorete EC2 per il gruppo di sottoreti di database.

Risposta

Contiene i dettagli di un gruppo di sottoreti di database Amazon Neptune.

Questo tipo di dati viene utilizzato come elemento di risposta nell'operazione DescribeDBSubnetGroups (operazione).

• DBSubnetGroupArn: una stringa di tipo string (una stringa con codifica UTF-8).

  Amazon Resource Name (ARN) per il gruppo di sottoreti di database.

• DBSubnetGroupDescription: una stringa di tipo string (una stringa con codifica UTF-8).

  Fornisce la descrizione del gruppo di sottoreti di database.

• DBSubnetGroupName: una stringa di tipo string (una stringa con codifica UTF-8).

  Il nome del gruppo di sottoreti DB.

• SubnetGroupStatus: una stringa di tipo string (una stringa con codifica UTF-8).

  Fornisce lo stato del gruppo di sottoreti di database.

• Subnets: una matrice di oggetti Sottorete.

  Include un elenco di elementi Sottorete (struttura).

• VpcId: una stringa di tipo string (una stringa con codifica UTF-8).

  Fornisce il VpcId del gruppo di sottoreti di database.

Errori

• DBSubnetGroupNotFoundFault

• DBSubnetQuotaExceededFault

• SubnetAlreadyInUse

• DBSubnetGroupDoesNotCoverEnoughAZs

• InvalidSubnet

DescribeDBSubnetGroups (operazione)

        Il nome AWS CLI per questa API è: describe-db-subnet-groups.

Restituisce un elenco di descrizioni DBSubnetGroup. Se viene specificato un DBSubnetGroupName, l'elenco conterrà solo la descrizione del DBSubnetGroup specificato.

Per una panoramica degli intervalli CIDR, consulta Tutorial di Wikipedia.

Richiesta

• DBSubnetGroupName (nella CLI: --db-subnet-group-name): una stringa di tipo string (una stringa con codifica UTF-8).

  Nome del gruppo di sottoreti di database per il quale restituire i dettagli.

• Filters (nella CLI: --filters): un array di oggetti Filtro.

  Questo parametro non è attualmente supportato.

• Marker (nella CLI: --marker): una stringa di tipo string (una stringa con codifica UTF-8).

  Token di paginazione opzionale fornito da una richiesta DescribeDBSubnetGroups precedente. Se questo parametro viene specificato, la risposta include solo i record oltre il contrassegno, fino al valore specificato da MaxRecords.

• MaxRecords (nella CLI: --max-records): un valore IntegerOptional di tipo integer (numero intero a 32 bit con segno).

  Numero massimo di record da includere nella risposta. Se sono presenti più record rispetto al valore di MaxRecords specificato, nella risposta viene incluso un token di paginazione detto contrassegno (oggetto Marker), per permettere di recuperare i risultati rimanenti.

  Impostazione predefinita: 100

  Vincoli: minimo 20, massimo 100.

Risposta

• DBSubnetGroups: una matrice di oggetti DBSubnetGroup.

  Elenco di istanze di DBSubnetGroup (struttura).

• Marker: una stringa di tipo string (una stringa con codifica UTF-8).

  Token di paginazione opzionale fornito da una richiesta precedente. Se questo parametro viene specificato, la risposta include solo i record oltre il contrassegno, fino al valore specificato da MaxRecords.

Errori

• DBSubnetGroupNotFoundFault

Strutture:

Sottorete (struttura)

Specifica una sottorete.

Questo tipo di dati viene utilizzato come elemento di risposta nell'operazione DescribeDBSubnetGroups (operazione).

Campi

• SubnetAvailabilityZone: questo è un oggetto AvailabilityZone.

  Specifica la zona di disponibilità EC2 in cui si trova la sottorete.

• SubnetIdentifier: questa è una stringa di tipo string (una stringa con codifica UTF-8).

  Specifica l'identificatore della sottorete.

• SubnetStatus: questa è una stringa di tipo string (una stringa con codifica UTF-8).

  Specifica lo stato della sottorete.

DBSubnetGroup (struttura)

Contiene i dettagli di un gruppo di sottoreti di database Amazon Neptune.

Questo tipo di dati viene utilizzato come elemento di risposta nell'operazione DescribeDBSubnetGroups (operazione).

Campi

• DBSubnetGroupArn: questa è una stringa di tipo string (una stringa con codifica UTF-8).

  Amazon Resource Name (ARN) per il gruppo di sottoreti di database.

• DBSubnetGroupDescription: questa è una stringa di tipo string (una stringa con codifica UTF-8).

  Fornisce la descrizione del gruppo di sottoreti di database.

• DBSubnetGroupName: questa è una stringa di tipo string (una stringa con codifica UTF-8).

  Il nome del gruppo di sottoreti DB.

• SubnetGroupStatus: questa è una stringa di tipo string (una stringa con codifica UTF-8).

  Fornisce lo stato del gruppo di sottoreti di database.

• Subnets: questo è un array di oggetti Sottorete.

  Include un elenco di elementi Sottorete (struttura).

• VpcId: questa è una stringa di tipo string (una stringa con codifica UTF-8).

  Fornisce il VpcId del gruppo di sottoreti di database.

DBSubnetGroup viene utilizzato come elemento di risposta per:

• CreateDBSubnetGroup

• ModifyDBSubnetGroup