API del database globale Neptune - Amazon Neptune

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

API del database globale Neptune

Operazioni:

Strutture:

CreateGlobalCluster (azione)

        Il nome AWS CLI per questa API è: create-global-cluster.

Crea un database globale Neptune distribuito in più regioni Amazon. Il database globale contiene un singolo cluster primario con funzionalità di lettura-scrittura e cluster secondari di sola lettura che ricevono i dati dal cluster primario tramite la replica ad alta velocità eseguita dal sottosistema di archiviazione Neptune.

È possibile creare un database globale inizialmente vuoto e poi aggiungervi un cluster primario e cluster secondari oppure specificare un cluster Neptune esistente durante l'operazione di creazione per trasformarlo nel cluster primario del database globale.

Richiesta

  • DatabaseName (nella CLI: --database-name): una stringa di tipo string (una stringa con codifica UTF-8).

    Il nome per il nuovo database globale (massimo di 64 caratteri alfanumerici).

  • DeletionProtection (nella CLI: --deletion-protection): un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione di protezione contro l'eliminazione per il nuovo database globale. Il database globale non può essere eliminato quando è abilitata la protezione contro l'eliminazione.

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

    Il nome del motore di database da utilizzare nel database globale.

    Valori validi: neptune

  • EngineVersion (nella CLI: --engine-version): una stringa di tipo string (una stringa con codifica UTF-8).

    La versione del motore Neptune da utilizzare dal database globale.

    Valori validi: 1.2.0.0 o superiore.

  • GlobalClusterIdentifier (nella CLI: --global-cluster-identifier): Obbligatorio: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Identificatore del cluster del nuovo cluster database globale.

  • SourceDBClusterIdentifier (nella CLI: --source-db-cluster-identifier): una stringa di tipo string (una stringa con codifica UTF-8).

    (Facoltativo) Il nome della risorsa Amazon (ARN) di un cluster database Neptune esistente da utilizzare come cluster primario del nuovo database globale.

  • StorageEncrypted (nella CLI: --storage-encrypted): un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione della crittografia di archiviazione per il nuovo cluster database globale.

Risposta

Contiene i dettagli di un database globale Amazon Neptune.

Questo tipo di dati viene utilizzato come elemento di risposta per le azioni CreateGlobalCluster (azione), DescribeGlobalClusters (azione), ModifyGlobalCluster (azione), DeleteGlobalCluster (azione), FailoverGlobalCluster (azione) e RemoveFromGlobalCluster (azione).

  • DeletionProtection: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione di protezione contro l'eliminazione per il database globale.

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

    Il motore di database Neptune utilizzato dal database globale ("neptune").

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

    La versione del motore Neptune utilizzata dal database globale.

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

    Il nome della risorsa Amazon (ARN) per il database globale.

  • GlobalClusterIdentifier: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Contiene un identificatore del cluster database globale fornito dall'utente. Questo identificatore è la chiave univoca che identifica un database globale.

  • GlobalClusterMembers: una matrice di oggetti GlobalClusterMember.

    Un elenco di ARN di cluster e ARN di istanze per tutti i cluster database che fanno parte del database globale.

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

    Un identificatore immutabile per il database globale, univoco in tutte le regioni. Questo identificativo è disponibile nelle voci di log di CloudTrail ogni volta che si accede alla chiave KMS per il cluster database.

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

    Specifica lo stato corrente del database globale.

  • StorageEncrypted: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione della crittografia di storage per il database globale.

DeleteGlobalCluster (azione)

        Il nome AWS CLI per questa API è: delete-global-cluster.

Elimina un database globale. Il cluster primario e tutti i cluster secondari devono essere già stati scollegati o eliminati.

Richiesta

  • GlobalClusterIdentifier (nella CLI: --global-cluster-identifier): Obbligatorio: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    L'identificatore del cluster del nuovo cluster database globale da eliminare.

Risposta

Contiene i dettagli di un database globale Amazon Neptune.

Questo tipo di dati viene utilizzato come elemento di risposta per le azioni CreateGlobalCluster (azione), DescribeGlobalClusters (azione), ModifyGlobalCluster (azione), DeleteGlobalCluster (azione), FailoverGlobalCluster (azione) e RemoveFromGlobalCluster (azione).

  • DeletionProtection: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione di protezione contro l'eliminazione per il database globale.

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

    Il motore di database Neptune utilizzato dal database globale ("neptune").

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

    La versione del motore Neptune utilizzata dal database globale.

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

    Il nome della risorsa Amazon (ARN) per il database globale.

  • GlobalClusterIdentifier: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Contiene un identificatore del cluster database globale fornito dall'utente. Questo identificatore è la chiave univoca che identifica un database globale.

  • GlobalClusterMembers: una matrice di oggetti GlobalClusterMember.

    Un elenco di ARN di cluster e ARN di istanze per tutti i cluster database che fanno parte del database globale.

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

    Un identificatore immutabile per il database globale, univoco in tutte le regioni. Questo identificativo è disponibile nelle voci di log di CloudTrail ogni volta che si accede alla chiave KMS per il cluster database.

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

    Specifica lo stato corrente del database globale.

  • StorageEncrypted: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione della crittografia di storage per il database globale.

ModifyGlobalCluster (azione)

        Il nome AWS CLI per questa API è: modify-global-cluster.

Modifica un'impostazione per un cluster globale di Amazon Neptune. Puoi modificare uno o più parametri di configurazione del database specificando questi parametri e i nuovi valori nella richiesta.

Richiesta

  • AllowMajorVersionUpgrade (nella CLI: --allow-major-version-upgrade): un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    Un valore che Indica che gli aggiornamenti delle versioni principali sono permessi.

    Vincoli: gli aggiornamenti delle versioni principali devono essere consentiti se specifichi un valore per il parametro EngineVersion con una versione principale diversa rispetto alla versione corrente dell'istanza database.

    Se aggiorni la versione principale di un database globale, i gruppi di parametri del cluster e dell'istanza database vengono impostati sui gruppi di parametri predefiniti per la nuova versione, quindi sarà necessario applicare eventuali gruppi di parametri personalizzati dopo aver completato l'aggiornamento.

  • DeletionProtection (nella CLI: --deletion-protection): un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    Un valore che indica se per il database globale è abilitata o meno la protezione da eliminazione. Il database globale non può essere eliminato quando è abilitata la protezione da eliminazione.

  • EngineVersion (nella CLI: --engine-version): una stringa di tipo string (una stringa con codifica UTF-8).

    Numero di versione del motore di database a cui eseguire l'aggiornamento. La modifica di questo parametro provoca un'interruzione. La modifica viene applicata durante la finestra di manutenzione successiva, a meno che il parametro ApplyImmediately non sia abilitato.

    Per ottenere un elenco di tutte le versioni dei motori Neptune disponibili, utilizza il comando seguente:

    aws neptune describe-db-engine-versions \ --engine neptune \ --query '*[]|[?SupportsGlobalDatabases == 'true'].[EngineVersion]'
  • GlobalClusterIdentifier (nella CLI: --global-cluster-identifier): Obbligatorio: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Identificatore del cluster database globale da modificare. Questo parametro non opera distinzione tra maiuscole e minuscole.

    Vincoli: deve corrispondere all'identificatore di un cluster database globale esistente.

  • NewGlobalClusterIdentifier (nella CLI: --new-global-cluster-identifier): un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Un nuovo identificatore di cluster da assegnare al database globale. Questo valore è archiviato come stringa in caratteri minuscoli.

    Vincoli:

    • Deve contenere da 1 a 63 lettere, numeri o trattini.

    • Il primo carattere deve essere una lettera.

    • Non può terminare con un trattino o contenere due trattini consecutivi

    Esempio: my-cluster2

Risposta

Contiene i dettagli di un database globale Amazon Neptune.

Questo tipo di dati viene utilizzato come elemento di risposta per le azioni CreateGlobalCluster (azione), DescribeGlobalClusters (azione), ModifyGlobalCluster (azione), DeleteGlobalCluster (azione), FailoverGlobalCluster (azione) e RemoveFromGlobalCluster (azione).

  • DeletionProtection: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione di protezione contro l'eliminazione per il database globale.

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

    Il motore di database Neptune utilizzato dal database globale ("neptune").

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

    La versione del motore Neptune utilizzata dal database globale.

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

    Il nome della risorsa Amazon (ARN) per il database globale.

  • GlobalClusterIdentifier: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Contiene un identificatore del cluster database globale fornito dall'utente. Questo identificatore è la chiave univoca che identifica un database globale.

  • GlobalClusterMembers: una matrice di oggetti GlobalClusterMember.

    Un elenco di ARN di cluster e ARN di istanze per tutti i cluster database che fanno parte del database globale.

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

    Un identificatore immutabile per il database globale, univoco in tutte le regioni. Questo identificativo è disponibile nelle voci di log di CloudTrail ogni volta che si accede alla chiave KMS per il cluster database.

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

    Specifica lo stato corrente del database globale.

  • StorageEncrypted: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione della crittografia di storage per il database globale.

DescribeGlobalClusters (azione)

        Il nome AWS CLI per questa API è: describe-global-clusters.

Restituisce informazioni sui cluster database globali di Neptune. Quest'API supporta la paginazione.

Richiesta

  • GlobalClusterIdentifier (nella CLI: --global-cluster-identifier): un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Identificatore del cluster database fornito dall'utente. Se questo parametro viene specificato, vengono restituite solo le informazioni del cluster database specificato. Questo parametro non opera distinzione tra maiuscole e minuscole.

    Vincoli: se viene specificato, deve corrispondere all'identificatore di un cluster database esistente.

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

    (Facoltativo) Token di paginazione restituito da una chiamata precedente a DescribeGlobalClusters. Se questo parametro viene specificato, la risposta include solo i record oltre il contrassegno, fino al numero 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 esistono più record rispetto al valore di MaxRecords specificato, nella risposta viene incluso un token di paginazione che permette di recuperare i risultati rimanenti.

    Impostazione predefinita: 100

    Vincoli: minimo 20, massimo 100.

Risposta

  • GlobalClusters: una matrice di oggetti GlobalCluster.

    L'elenco dei cluster e delle istanze globali restituiti da questa richiesta.

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

    Un token di paginazione. Se questo parametro viene restituito nella risposta, sono disponibili più record, che possono essere recuperati con una o più chiamate aggiuntive a DescribeGlobalClusters.

FailoverGlobalCluster (azione)

        Il nome AWS CLI per questa API è: failover-global-cluster.

Avvia il processo di failover per un database globale Neptune.

Un failover per un database globale Neptune promuove uno dei cluster database secondari di sola lettura in modo che diventi il cluster database primario. Inoltre, retrocede il cluster database primario a cluster database secondario (di sola lettura). In altre parole, il ruolo del cluster database primario corrente e del cluster database secondario di destinazione selezionato vengono scambiati. Il cluster database secondario selezionato assume funzionalità complete di lettura/scrittura per il database globale Neptune.

Nota

Questa azione si applica solo ai database globali Neptune. Questa azione è destinata esclusivamente all'uso su database globali Neptune integri con cluster database Neptune integri e senza interruzioni a livello regionale, per testare scenari di ripristino di emergenza o per riconfigurare la topologia del database globale.

Richiesta

  • GlobalClusterIdentifier (nella CLI: --global-cluster-identifier): Obbligatorio: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Identificatore del database globale Neptune su cui eseguire il failover. L'identificatore è la chiave univoca assegnata dall'utente al momento della creazione del database globale Neptune. In altre parole, è il nome del database globale di cui eseguire il failover.

    Vincoli: deve corrispondere all'identificatore di un cluster database globale esistente.

  • TargetDbClusterIdentifier (nella CLI: --target-db-cluster-identifier): Obbligatorio: una stringa di tipo string (una stringa con codifica UTF-8).

    Il nome della risorsa Amazon (ARN) del cluster database Neptune da promuovere in modo che diventi quello primario per il database globale.

Risposta

Contiene i dettagli di un database globale Amazon Neptune.

Questo tipo di dati viene utilizzato come elemento di risposta per le azioni CreateGlobalCluster (azione), DescribeGlobalClusters (azione), ModifyGlobalCluster (azione), DeleteGlobalCluster (azione), FailoverGlobalCluster (azione) e RemoveFromGlobalCluster (azione).

  • DeletionProtection: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione di protezione contro l'eliminazione per il database globale.

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

    Il motore di database Neptune utilizzato dal database globale ("neptune").

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

    La versione del motore Neptune utilizzata dal database globale.

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

    Il nome della risorsa Amazon (ARN) per il database globale.

  • GlobalClusterIdentifier: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Contiene un identificatore del cluster database globale fornito dall'utente. Questo identificatore è la chiave univoca che identifica un database globale.

  • GlobalClusterMembers: una matrice di oggetti GlobalClusterMember.

    Un elenco di ARN di cluster e ARN di istanze per tutti i cluster database che fanno parte del database globale.

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

    Un identificatore immutabile per il database globale, univoco in tutte le regioni. Questo identificativo è disponibile nelle voci di log di CloudTrail ogni volta che si accede alla chiave KMS per il cluster database.

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

    Specifica lo stato corrente del database globale.

  • StorageEncrypted: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione della crittografia di storage per il database globale.

RemoveFromGlobalCluster (azione)

        Il nome AWS CLI per questa API è: remove-from-global-cluster.

Scollega un cluster database Neptune da un database globale Neptune. Un cluster secondario diventa un normale cluster autonomo con funzionalità di lettura/scrittura, anziché essere di sola lettura. Inoltre, non riceve più dati dal cluster primario.

Richiesta

  • DbClusterIdentifier (nella CLI: --db-cluster-identifier): Obbligatorio: una stringa di tipo string (una stringa con codifica UTF-8).

    Il nome della risorsa Amazon (ARN) che identifica il cluster da scollegare dal cluster database globale Neptune.

  • GlobalClusterIdentifier (nella CLI: --global-cluster-identifier): Obbligatorio: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    L'identificatore del database globale Neptune da cui scollegare il cluster database Neptune specificato.

Risposta

Contiene i dettagli di un database globale Amazon Neptune.

Questo tipo di dati viene utilizzato come elemento di risposta per le azioni CreateGlobalCluster (azione), DescribeGlobalClusters (azione), ModifyGlobalCluster (azione), DeleteGlobalCluster (azione), FailoverGlobalCluster (azione) e RemoveFromGlobalCluster (azione).

  • DeletionProtection: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione di protezione contro l'eliminazione per il database globale.

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

    Il motore di database Neptune utilizzato dal database globale ("neptune").

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

    La versione del motore Neptune utilizzata dal database globale.

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

    Il nome della risorsa Amazon (ARN) per il database globale.

  • GlobalClusterIdentifier: un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Contiene un identificatore del cluster database globale fornito dall'utente. Questo identificatore è la chiave univoca che identifica un database globale.

  • GlobalClusterMembers: una matrice di oggetti GlobalClusterMember.

    Un elenco di ARN di cluster e ARN di istanze per tutti i cluster database che fanno parte del database globale.

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

    Un identificatore immutabile per il database globale, univoco in tutte le regioni. Questo identificativo è disponibile nelle voci di log di CloudTrail ogni volta che si accede alla chiave KMS per il cluster database.

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

    Specifica lo stato corrente del database globale.

  • StorageEncrypted: un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione della crittografia di storage per il database globale.

Strutture:

GlobalCluster (struttura)

Contiene i dettagli di un database globale Amazon Neptune.

Questo tipo di dati viene utilizzato come elemento di risposta per le azioni CreateGlobalCluster (azione), DescribeGlobalClusters (azione), ModifyGlobalCluster (azione), DeleteGlobalCluster (azione), FailoverGlobalCluster (azione) e RemoveFromGlobalCluster (azione).

Campi
  • DeletionProtection: questo è un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione di protezione contro l'eliminazione per il database globale.

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

    Il motore di database Neptune utilizzato dal database globale ("neptune").

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

    La versione del motore Neptune utilizzata dal database globale.

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

    Il nome della risorsa Amazon (ARN) per il database globale.

  • GlobalClusterIdentifier: questo è un valore GlobalClusterIdentifier di tipo string (stringa codificata UTF-8), non inferiore a 1 o superiore a 255 ?st?s, corrispondente a questa espressione regolare: [A-Za-z][0-9A-Za-z-:._]*.

    Contiene un identificatore del cluster database globale fornito dall'utente. Questo identificatore è la chiave univoca che identifica un database globale.

  • GlobalClusterMembers: questo è un array di oggetti GlobalClusterMember.

    Un elenco di ARN di cluster e ARN di istanze per tutti i cluster database che fanno parte del database globale.

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

    Un identificatore immutabile per il database globale, univoco in tutte le regioni. Questo identificativo è disponibile nelle voci di log di CloudTrail ogni volta che si accede alla chiave KMS per il cluster database.

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

    Specifica lo stato corrente del database globale.

  • StorageEncrypted: questo è un valore BooleanOptional di tipo boolean [un valore booleano (vero o falso)].

    L'impostazione della crittografia di storage per il database globale.

GlobalCluster viene utilizzato come elemento di risposta per:

GlobalClusterMember (struttura)

Una struttura di dati con informazioni su tutti i cluster primari e secondari associati a un database globale Neptune.

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

    Il nome della risorsa Amazon (ARN) per ogni cluster Neptune.

  • IsWriter: questo è un valore booleano di tipo boolean [un valore booleano (vero o falso)].

    Specifica se il cluster Neptune è quello primario (ovvero dispone di funzionalità di lettura/scrittura) per il database globale Neptune a cui è associato.

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

    Il nome della risorsa Amazon (ARN) per ogni cluster secondario di sola lettura associato al database globale Neptune.