CreateDBCluster - Amazon DocumentDB

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à.

CreateDBCluster

Crea un nuovo cluster Amazon DocumentDB.

Parametri della richiesta

Per informazioni sui parametri comuni per tutte le azioni, consulta Parametri comuni.

DBClusterIdentifier

Identificatore del cluster. Questo parametro è archiviato come stringa in minuscolo.

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-cluster

Tipo: stringa

Campo obbligatorio: sì

Engine

Il nome del motore di database da utilizzare per questo cluster.

Valori validi: docdb

Tipo: stringa

Campo obbligatorio: sì

AvailabilityZones. AvailabilityZoneN.

Elenco delle zone di disponibilità Amazon EC2 in cui possono essere create istanze nel cluster.

Tipo: matrice di stringhe

Campo obbligatorio: no

BackupRetentionPeriod

Il numero di giorni durante i quali vengono conservati i backup automatici. È necessario specificare un valore minimo pari a 1.

Impostazione predefinita: 1

Vincoli:

  • Il valore deve essere compreso tra 1 e 35.

Tipo: integer

Campo obbligatorio: no

DBClusterParameterGroupName

Il nome del gruppo di parametri del cluster da associare a questo cluster.

▬Tipo: stringa

Campo obbligatorio: no

DBSubnetGroupName

Gruppo di sottoreti da associare a questo cluster.

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

Esempio: mySubnetgroup

▬Tipo: stringa

Campo obbligatorio: no

DeletionProtection

Speciifica se questo cluster può essere eliminato. Se DeletionProtection è abilitato, il cluster non può essere eliminato a meno che non venga modificato e DeletionProtection disabilitato. DeletionProtectionprotegge i cluster dall'eliminazione accidentale.

Tipo: Booleano

Campo obbligatorio: no

EnableCloudwatchLogsExports.Member.

Un elenco di tipi di log che devono essere abilitati per l'esportazione in Amazon CloudWatch Logs. È possibile abilitare i log di audit o i log del profiler. Per ulteriori informazioni, consulta Auditing Amazon DocumentDB Events e Profiling Amazon DocumentDB Operations.

Tipo: matrice di stringhe

Campo obbligatorio: no

EngineVersion

Numero di versione del motore di database da utilizzare. Per impostazione predefinita, --engine-version sarà l'ultima versione principale del motore. Per i carichi di lavoro di produzione, è consigliabile dichiarare esplicitamente questo parametro con la versione principale del motore prevista.

▬Tipo: stringa

Campo obbligatorio: no

GlobalClusterIdentifier

L'identificatore del nuovo cluster globale.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 1. Lunghezza massima di 255.

Modello: [A-Za-z][0-9A-Za-z-:._]*

Campo obbligatorio: no

KmsKeyId

L'identificatore della AWS KMS chiave per un cluster crittografato.

L'identificatore della AWS KMS chiave è Amazon Resource Name (ARN) per AWS KMS la chiave di crittografia. Se si crea un cluster utilizzando Account AWS lo stesso proprietario della chiave di AWS KMS crittografia utilizzata per crittografare il nuovo cluster, è possibile utilizzare l'alias della AWS KMS chiave anziché l'ARN per la chiave di crittografia. AWS KMS

Se non è specificata una chiave di crittografia in KmsKeyId:

  • Se il parametro StorageEncrypted è true, Amazon DocumentDB utilizza la chiave di crittografia predefinita.

AWS KMS crea la chiave di crittografia predefinita per il tuo. Account AWS La tua Account AWS ha una chiave di crittografia predefinita diversa per ciascuna Regioni AWS.

▬Tipo: stringa

Campo obbligatorio: no

MasterUsername

Nome dell'utente master per il cluster.

Vincoli:

  • Deve contenere da 1 a 63 lettere o numeri.

  • Il primo carattere deve essere una lettera.

  • Non può essere una parola riservata per il motore di database scelto.

▬Tipo: stringa

Campo obbligatorio: no

MasterUserPassword

La password per l'utente del database master. Questa password può contenere qualsiasi carattere ASCII stampabile, eccetto la barra (/), le virgolette (") o il simbolo chiocciola (@).

Vincoli: deve contenere da 8 a 100 caratteri.

▬Tipo: stringa

Campo obbligatorio: no

Port

Il numero di porta su cui le istanze del cluster accettano connessioni.

Tipo: integer

Campo obbligatorio: no

PreferredBackupWindow

Intervallo di tempo giornaliero durante il quale vengono creati i backup automatici se sono abilitati tramite il parametro BackupRetentionPeriod.

L'impostazione predefinita è una finestra di 30 minuti selezionata a caso da un intervallo di tempo di 8 ore per ciascuna. Regione AWS

Vincoli:

  • Il valore deve essere nel formato hh24:mi-hh24:mi.

  • Il valore deve essere nel fuso orario UTC (Universal Coordinated Time).

  • Il valore non deve essere in conflitto con la finestra di manutenzione preferita.

  • Il valore deve essere almeno di 30 minuti.

▬Tipo: stringa

Campo obbligatorio: no

PreferredMaintenanceWindow

Intervallo temporale settimanale nel fuso orario UTC (Universal Coordinated Time) durante il quale può verificarsi la manutenzione dei sistemi.

Formato: ddd:hh24:mi-ddd:hh24:mi

L'impostazione predefinita è una finestra di 30 minuti selezionata a caso da un intervallo di tempo di 8 ore per ciascuna Regione AWS, che si verifica in un giorno casuale della settimana.

Giorni validi: lunedì, martedì, mercoledì, giovedì, venerdì, sabato, domenica

Vincoli: finestra di un minimo di 30 minuti.

▬Tipo: stringa

Campo obbligatorio: no

PreSignedUrl

Attualmente non è supportato.

▬Tipo: stringa

Campo obbligatorio: no

StorageEncrypted

Specifica se il cluster è crittografato.

Tipo: Booleano

Campo obbligatorio: no

StorageType

Il tipo di archiviazione da associare al cluster di database.

Per informazioni sui tipi di storage per i cluster Amazon DocumentDB, consulta le configurazioni di storage dei cluster nella Amazon DocumentDB Developer Guide.

Valori validi per il tipo di storage - standard | iopt1

Il valore predefinito è standard

Nota

Quando si crea un cluster DocumentDB DB con il tipo di archiviazione impostato suiopt1, il tipo di archiviazione viene restituito nella risposta. Il tipo di archiviazione non viene restituito quando lo si imposta su. standard

▬Tipo: stringa

Campo obbligatorio: no

Tag.Tag.N

I tag da assegnare al cluster.

Tipo: matrice di oggetti Tag

Campo obbligatorio: no

VpcSecurityGroupIds. VpcSecurityGroupIdN.

Elenco dei gruppi di sicurezza VPC EC2 da associare a questo cluster.

Tipo: matrice di stringhe

Campo obbligatorio: no

Elementi di risposta

Il servizio restituisce il seguente elemento.

DBCluster

Informazioni dettagliate su un cluster.

Tipo: oggetto DBCluster

Errori

Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.

DBClusterAlreadyExistsFault

Hai già un cluster con l'identificatore fornito.

Codice di stato HTTP: 400

DBClusterNotFoundFault

DBClusterIdentifiernon fa riferimento a un cluster esistente.

Codice di stato HTTP: 404

DBClusterParameterGroupNotFound

DBClusterParameterGroupNamenon fa riferimento a un gruppo di parametri del cluster esistente.

Codice di stato HTTP: 404

DBClusterQuotaExceededFault

Il cluster non può essere creato perché è stata raggiunta la quota massima consentita di cluster.

Codice di stato HTTP: 403

DBInstanceNotFound

DBInstanceIdentifiernon fa riferimento a un'istanza esistente.

Codice di stato HTTP: 404

DBSubnetGroupDoesNotCoverEnoughAZs

Le sottoreti del gruppo di sottoreti devono coprire almeno due zone di disponibilità, a meno che non esista una sola zona di disponibilità.

Codice di stato HTTP: 400

DBSubnetGroupNotFoundFault

DBSubnetGroupNamenon fa riferimento a un gruppo di sottoreti esistente.

Codice di stato HTTP: 404

GlobalClusterNotFoundFault

GlobalClusterIdentifierNon si riferisce a un cluster globale esistente.

Codice di stato HTTP: 404

InsufficientStorageClusterCapacity

Lo spazio di archiviazione disponibile non è sufficiente per l'azione corrente. È possibile risolvere questo errore aggiornando il gruppo di sottoreti in modo che utilizzi zone di disponibilità diverse con più spazio di archiviazione disponibile.

Codice di stato HTTP: 400

InvalidDBClusterStateFault

Il cluster non è in uno stato valido.

Codice di stato HTTP: 400

InvalidDBInstanceState

L'istanza specificata non è nello stato disponibile.

Codice di stato HTTP: 400

InvalidDBSubnetGroupStateFault

Il gruppo di sottoreti non può essere eliminato perché è in uso.

Codice di stato HTTP: 400

InvalidGlobalClusterStateFault

L'operazione richiesta non può essere eseguita mentre il cluster si trova in questo stato.

Codice di stato HTTP: 400

InvalidSubnet

La sottorete richiesta non è valida oppure sono state richieste più sottoreti che non si trovano tutte in un cloud privato virtuale (VPC) comune.

Codice di stato HTTP: 400

InvalidVPCNetworkStateFault

Il gruppo di sottoreti non copre tutte le zone di disponibilità dopo la creazione a causa delle modifiche apportate.

Codice di stato HTTP: 400

KMSKeyNotAccessibleFault

Si è verificato un errore durante l'accesso a una AWS KMS chiave.

Codice di stato HTTP: 400

StorageQuotaExceeded

La richiesta comporterebbe il superamento della quantità di storage consentita disponibile in tutte le istanze.

Codice di stato HTTP: 400

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue: