DBCluster

Informazioni dettagliate su un cluster.

Indice

Nota

Nell'elenco seguente, i parametri richiesti vengono descritti per primi.

AssociatedRoles.DBClusterRole.N

Fornisce un elenco dei ruoli AWS Identity and Access Management (IAM) associati al cluster. I ruoli (IAM) associati a un cluster concedono l'autorizzazione al cluster di accedere ad altri AWS servizi per conto dell'utente.

Tipo: matrice di oggetti DBClusterRole

Campo obbligatorio: no

AvailabilityZones.AvailabilityZone.N

Fornisce l'elenco delle zone di EC2 disponibilità Amazon in cui è possibile creare le istanze del cluster.

Tipo: matrice di stringhe

Campo obbligatorio: no

BackupRetentionPeriod

Speciifica il numero di giorni per i quali vengono conservate le istantanee automatiche.

Tipo: integer

Campo obbligatorio: no

CloneGroupId

Identifica il gruppo di cloni a cui è associato il cluster di database.

Tipo: string

Campo obbligatorio: no

ClusterCreateTime

Speciifica l'ora in cui è stato creato il cluster, in UTC (Universal Coordinated Time).

Tipo: Timestamp

Campo obbligatorio: no

DBClusterArn

L'Amazon Resource Name (ARN) per il cluster.

Tipo: string

Campo obbligatorio: no

DBClusterIdentifier

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

Tipo: string

Campo obbligatorio: no

DBClusterMembers.DBClusterMember.N

Fornisce l'elenco delle istanze che compongono il cluster.

Tipo: matrice di oggetti DBClusterMember

Campo obbligatorio: no

DBClusterParameterGroup

Speciifica il nome del gruppo di parametri del cluster per il cluster.

Tipo: string

Campo obbligatorio: no

DbClusterResourceId

L'identificatore Regione AWS-unique e immutabile per il cluster. Questo identificatore si trova nelle voci di AWS CloudTrail registro ogni volta che si accede alla AWS KMS chiave per il cluster.

Tipo: string

Campo obbligatorio: no

DBSubnetGroup

Speciifica le informazioni sul gruppo di sottoreti associato al cluster, inclusi il nome, la descrizione e le sottoreti del gruppo di sottoreti.

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 e DeletionProtection disabilitato. DeletionProtectionprotegge i cluster dall'eliminazione accidentale.

Tipo: Booleano

Campo obbligatorio: no

EarliestRestorableTime

Il primo momento in cui un database può essere ripristinato con point-in-time restore.

Tipo: Timestamp

Campo obbligatorio: no

EnabledCloudwatchLogsExports.member.N

Un elenco di tipi di log che questo cluster è configurato per esportare in Amazon CloudWatch Logs.

Tipo: matrice di stringhe

Campo obbligatorio: no

Endpoint

Speciifica l'endpoint di connessione per l'istanza principale del cluster.

Tipo: string

Campo obbligatorio: no

Engine

Fornisce il nome del motore di database da utilizzare per questo cluster.

Tipo: string

Campo obbligatorio: no

EngineVersion

Indica la versione del motore di database.

Tipo: string

Campo obbligatorio: no

HostedZoneId

Specifica l'ID che Amazon Route 53 assegna al momento della creazione di una zona ospitata.

Tipo: string

Campo obbligatorio: no

IOOptimizedNextAllowedModificationTime

La prossima volta potrai modificare il cluster Amazon DocumentDB per utilizzare il tipo di storage iopt1.

Tipo: Timestamp

Campo obbligatorio: no

KmsKeyId

In caso StorageEncrypted affermativotrue, l'identificatore della AWS KMS chiave per il cluster crittografato.

Tipo: string

Campo obbligatorio: no

LatestRestorableTime

Speciifica l'ora più recente alla quale un database può essere ripristinato con point-in-time restore.

Tipo: Timestamp

Campo obbligatorio: no

MasterUsername

Contiene il nome utente principale per il cluster.

Tipo: string

Campo obbligatorio: no

MasterUserSecret

Il segreto gestito da Amazon DocumentDB in AWS Secrets Manager per la password dell'utente principale.

Tipo: oggetto ClusterMasterUserSecret

Campo obbligatorio: no

MultiAZ

Speciifica se il cluster dispone di istanze in più zone di disponibilità.

Tipo: Booleano

Campo obbligatorio: no

PercentProgress

Specifica l'avanzamento dell'operazione sotto forma di percentuale.

Tipo: string

Campo obbligatorio: no

Port

Specifica la porta su cui è in ascolto il motore di database.

Tipo: integer

Campo obbligatorio: no

PreferredBackupWindow

Specifica l'intervallo di tempo giornaliero in cui vengono creati i backup automatici se questi sono abilitati, come determinato da BackupRetentionPeriod.

Tipo: string

Campo obbligatorio: no

PreferredMaintenanceWindow

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

Tipo: string

Campo obbligatorio: no

ReaderEndpoint

L'endpoint di lettura per il cluster. L'endpoint di lettura per un cluster bilancia il carico delle connessioni tra le repliche di Amazon DocumentDB disponibili in un cluster. Quando i client richiedono nuove connessioni all'endpoint del lettore, Amazon DocumentDB distribuisce le richieste di connessione tra le repliche di Amazon DocumentDB nel cluster. Questa funzionalità può aiutare a bilanciare il carico di lavoro di lettura su più repliche di Amazon DocumentDB nel cluster.

Se si verifica un failover e la replica di Amazon DocumentDB a cui sei connesso viene promossa a istanza principale, la connessione viene interrotta. Per continuare a inviare il carico di lavoro di lettura ad altre repliche di Amazon DocumentDB nel cluster, puoi riconnetterti all'endpoint di lettura.

Tipo: string

Campo obbligatorio: no

ReadReplicaIdentifiers.ReadReplicaIdentifier.N

Contiene uno o più identificatori dei cluster secondari associati a questo cluster.

Tipo: matrice di stringhe

Campo obbligatorio: no

ReplicationSourceIdentifier

Contiene l'identificatore del cluster di origine se questo cluster è un cluster secondario.

Tipo: string

Campo obbligatorio: no

ServerlessV2ScalingConfiguration

La configurazione di scalabilità di un cluster Amazon DocumentDB Serverless.

Tipo: oggetto ServerlessV2ScalingConfigurationInfo

Campo obbligatorio: no

Status

Specifica lo stato attuale di questo cluster.

Tipo: string

Campo obbligatorio: no

StorageEncrypted

Specifica se il cluster è crittografato.

Tipo: Booleano

Campo obbligatorio: no

StorageType

Tipo di archiviazione associato al cluster

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

VpcSecurityGroups.VpcSecurityGroupMembership.N

Fornisce un elenco di gruppi di sicurezza del cloud privato virtuale (VPC) a cui appartiene il cluster.

Tipo: matrice di oggetti VpcSecurityGroupMembership

Campo obbligatorio: no

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in una delle lingue specifiche AWS SDKs, consulta quanto segue:

• AWS SDK per C++

• AWS SDK per Java V2

• AWS SDK per Ruby V3