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à.
ModifyDBCluster
Modifica un'impostazione per un cluster Amazon DocumentDB. Puoi modificare uno o più parametri di configurazione del database specificando questi parametri e i nuovi valori nella richiesta.
Parametri della richiesta
Per informazioni sui parametri comuni per tutte le azioni, consulta Parametri comuni.
- DBClusterIdentifier
-
L'identificatore del cluster per il cluster che viene modificato. Questo parametro non distingue tra maiuscole e minuscole.
Vincoli:
-
Deve corrispondere all'identificativo di un
DBCluster
esistente.
Tipo: stringa
Campo obbligatorio: sì
-
- AllowMajorVersionUpgrade
-
Un valore che Indica che gli aggiornamenti delle versioni principali sono permessi.
Vincoli: è necessario consentire gli aggiornamenti delle versioni principali quando si specifica un valore per il
EngineVersion
parametro che è una versione principale diversa dalla versione corrente del cluster DB.Tipo: Booleano
Campo obbligatorio: no
- ApplyImmediately
-
Un valore che specifica se le modifiche in questa richiesta e le eventuali modifiche in sospeso vengono applicate in modo asincrono il prima possibile, indipendentemente dall'impostazione per il cluster.
PreferredMaintenanceWindow
Se questo parametro è impostato sufalse
, le modifiche al cluster vengono applicate durante la finestra di manutenzione successiva.Il
ApplyImmediately
parametro influisce solo suiMasterUserPassword
valoriNewDBClusterIdentifier
and. Se impostate questo valore del parametro sufalse
, le modifiche aiMasterUserPassword
valoriNewDBClusterIdentifier
and vengono applicate durante la finestra di manutenzione successiva. Tutte le altre modifiche vengono applicate immediatamente, indipendentemente dal valore del parametroApplyImmediately
.Impostazione predefinita:
false
Tipo: Booleano
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
-
- CloudwatchLogsExportConfiguration
-
L'impostazione di configurazione per i tipi di log da abilitare per l'esportazione in Amazon CloudWatch Logs per un'istanza o un cluster specifico. Gli
DisableLogTypes
arrayEnableLogTypes
and determinano quali log vengono esportati (o non esportati) in Logs. CloudWatchTipo: oggetto CloudwatchLogsExportConfiguration
Campo obbligatorio: no
- DBClusterParameterGroupName
-
Il nome del gruppo di parametri del cluster da utilizzare per il cluster.
Tipo: string
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 eDeletionProtection
disabilitato.DeletionProtection
protegge i cluster dall'eliminazione accidentale.Tipo: Booleano
Campo obbligatorio: no
- EngineVersion
-
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 elencare tutte le versioni del motore disponibili per Amazon DocumentDB, usa il seguente comando:
aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"
Tipo: string
Campo obbligatorio: no
- ManageMasterUserPassword
-
Speciifica se gestire la password dell'utente principale con Amazon Web Services Secrets Manager. Se il cluster non gestisce la password dell'utente principale con Amazon Web Services Secrets Manager, puoi attivare questa gestione. In questo caso, non puoi specificare
MasterUserPassword
. Se il cluster gestisce già la password dell'utente principale con Amazon Web Services Secrets Manager e specifichi che la password dell'utente principale non è gestita con Amazon Web Services Secrets Manager, devi specificareMasterUserPassword
. In questo caso, Amazon DocumentDB elimina il segreto e utilizza la nuova password per l'utente master specificato da.MasterUserPassword
Tipo: Booleano
Campo obbligatorio: no
- MasterUserPassword
-
La password per l'utente del database master. Questa password può contenere qualsiasi ASCII carattere stampabile tranne la barra (/), le virgolette doppie («) o il simbolo «at» (@).
Vincoli: deve contenere da 8 a 100 caratteri.
Tipo: string
Campo obbligatorio: no
- MasterUserSecretKmsKeyId
-
L'identificatore KMS chiave di Amazon Web Services per crittografare un segreto che viene generato e gestito automaticamente in Amazon Web Services Secrets Manager.
Questa impostazione è valida solo se sono soddisfatte entrambe le seguenti condizioni:
-
Il cluster non gestisce la password dell'utente principale in Amazon Web Services Secrets Manager. Se il cluster gestisce già la password dell'utente principale in Amazon Web Services Secrets Manager, non puoi modificare la KMS chiave utilizzata per crittografare il segreto.
-
Stai abilitando
ManageMasterUserPassword
la gestione della password utente principale in Amazon Web Services Secrets Manager. Se lo stai attivandoManageMasterUserPassword
e non lo specifichiMasterUserSecretKmsKeyId
, laaws/secretsmanager
KMS chiave viene utilizzata per crittografare il segreto. Se il segreto si trova in un altro account Amazon Web Services, non puoi utilizzare laaws/secretsmanager
KMS chiave per crittografare il segreto e devi utilizzare una KMS chiave gestita dal cliente.
L'identificatore della KMS chiave di Amazon Web Services è la chiaveARN, l'ID chiave, l'alias ARN o il nome alias della chiave. KMS Per utilizzare una KMS chiave in un altro account Amazon Web Services, specifica la chiave ARN o l'aliasARN.
Esiste una KMS chiave predefinita per il tuo account Amazon Web Services. Il tuo account Amazon Web Services ha una KMS chiave predefinita diversa per ogni regione Amazon Web Services.
Tipo: string
Campo obbligatorio: no
-
- NewDBClusterIdentifier
-
Il nuovo identificatore per il cluster quando un cluster viene rinominato. 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
Tipo: string
Campo obbligatorio: no
-
- Port
-
Numero della porta sulla quale il cluster accetta le connessioni.
Vincoli: deve essere un valore compreso tra a
1150
.65535
Impostazione predefinita: la stessa porta del cluster originale.
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 blocco di tempo di 8 ore per ciascuna. Regione AWS
Vincoli:
-
Il valore deve essere nel formato
hh24:mi-hh24:mi
. -
Deve essere in Universal Coordinated Time ()UTC.
-
Il valore non deve essere in conflitto con la finestra di manutenzione preferita.
-
Il valore deve essere almeno di 30 minuti.
Tipo: string
Campo obbligatorio: no
-
- PreferredMaintenanceWindow
-
L'intervallo di tempo settimanale durante il quale può avvenire la manutenzione del sistema, in Universal Coordinated Time (UTC).
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: string
Campo obbligatorio: no
- RotateMasterUserPassword
-
Speciifica se ruotare il segreto gestito da Amazon Web Services Secrets Manager per la password dell'utente principale.
Questa impostazione è valida solo se la password dell'utente principale è gestita da Amazon DocumentDB in Amazon Web Services Secrets Manager per il cluster. Il valore segreto contiene la password aggiornata.
Vincolo: è necessario applicare la modifica immediatamente quando si ruota la password dell'utente principale.
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
Tipo: string
Campo obbligatorio: no
- VpcSecurityGroupIds. VpcSecurityGroupIdN.
-
Un elenco di gruppi di sicurezza del cloud privato virtuale (VPC) a cui apparterrà il 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.
HTTPCodice di stato: 400
- DBClusterNotFoundFault
-
DBClusterIdentifier
non si riferisce a un cluster esistente.HTTPCodice di stato: 404
- DBClusterParameterGroupNotFound
-
DBClusterParameterGroupName
non fa riferimento a un gruppo di parametri del cluster esistente.HTTPCodice di stato: 404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupName
non fa riferimento a un gruppo di sottoreti esistente.HTTPCodice di stato: 404
- InvalidDBClusterStateFault
-
Il cluster non è in uno stato valido.
HTTPCodice di stato: 400
- InvalidDBInstanceState
-
L'istanza specificata non è nello stato disponibile.
HTTPCodice di stato: 400
- InvalidDBSecurityGroupState
-
Lo stato del gruppo di sicurezza non consente l'eliminazione.
HTTPCodice di stato: 400
- InvalidDBSubnetGroupStateFault
-
Il gruppo di sottoreti non può essere eliminato perché è in uso.
HTTPCodice di stato: 400
- InvalidSubnet
-
La sottorete richiesta non è valida oppure sono state richieste più sottoreti che non si trovano tutte in un cloud privato virtuale comune (). VPC
HTTPCodice di stato: 400
- InvalidVPCNetworkStateFault
-
Il gruppo di sottoreti non copre tutte le zone di disponibilità dopo la sua creazione a causa delle modifiche apportate.
HTTPCodice di stato: 400
- StorageQuotaExceeded
-
La richiesta comporterebbe il superamento della quantità di storage consentita disponibile in tutte le istanze.
HTTPCodice di stato: 400
Vedi anche
Per ulteriori informazioni sull'utilizzo API in una delle lingue specifiche AWS SDKs, consulta quanto segue: