Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# DBCluster
Información detallada sobre un clúster.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** AssociatedRoles.DBClusterRole.N **
Proporciona una lista de los roles AWS Identity and Access Management (IAM) que están asociados con un clúster de base de datos. Los roles de IAM asociados a un clúster conceden permisos para que dicho clúster acceda a otros servicios de AWS en su nombre.
Tipo: matriz de objetos [DBClusterRole](API_DBClusterRole.md)
Obligatorio: no
** AvailabilityZones.AvailabilityZone.N **
Proporciona la lista de zonas de disponibilidad de Amazon EC2 en las que se pueden crear instancias en el clúster.
Tipo: matriz de cadenas
Obligatorio: no
** BackupRetentionPeriod **
Especifica el número de días durante los que se retienen las instantáneas automáticas.
Tipo: entero
Obligatorio: no
** CloneGroupId **
Identifica el grupo de clones al que está asociado el clúster de base de datos.
Tipo: cadena
Requerido: no
** ClusterCreateTime **
Especifica la hora a la que se creó el clúster, en tiempo universal coordinado (UTC).
Tipo: marca temporal
Obligatorio: no
** DBClusterArn **
El Nombre de recurso de Amazon (ARN) para el clúster.
Tipo: cadena
Requerido: no
** DBClusterIdentifier **
Contiene un identificador de clúster suministrado por el usuario. Este identificador es la clave única que identifica un clúster.
Tipo: cadena
Requerido: no
** DBClusterMembers.DBClusterMember.N **
Proporciona la lista de instancias que componen el clúster.
Tipo: matriz de objetos [DBClusterMember](API_DBClusterMember.md)
Obligatorio: no
** DBClusterParameterGroup **
Especifica el nombre del grupo de parámetros de clúster para el clúster.
Tipo: cadena
Requerido: no
** DbClusterResourceId **
El identificador inmutable único de Región de AWS para el clúster. Este identificador se encuentra en las entradas de registro de AWS CloudTrail cada vez que se accede a la clave de AWS KMS del clúster.
Tipo: cadena
Requerido: no
** DBSubnetGroup **
Especifica información sobre el grupo de subred asociado con el clúster, incluido el nombre, la descripción y subredes en el grupo de subred.
Tipo: cadena
Requerido: no
** DeletionProtection **
Especifica si se puede eliminar este clúster. Si `DeletionProtection` está habilitado, no se puede eliminar el clúster a menos que se modifique y `DeletionProtection` esté deshabilitado. `DeletionProtection` protege los clústeres de una eliminación accidental.
Tipo: Booleano
Obligatorio: no
** EarliestRestorableTime **
Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
Tipo: marca temporal
Obligatorio: no
** EnabledCloudwatchLogsExports.member.N **
Una lista de tipos de registro para los que este clúster está configurado para exportar a los Registros de Amazon CloudWatch.
Tipo: matriz de cadenas
Obligatorio: no
** Endpoint **
Especifica el punto de conexión para la instancia principal del clúster.
Tipo: cadena
Requerido: no
** Engine **
Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster.
Tipo: cadena
Requerido: no
** EngineVersion **
Indica la versión del motor de base de datos.
Tipo: cadena
Requerido: no
** HostedZoneId **
Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
Tipo: cadena
Requerido: no
** IOOptimizedNextAllowedModificationTime **
La próxima vez, podrá modificar el clúster de Amazon DocumentDB para utilizar el tipo de almacenamiento iopt1.
Tipo: marca temporal
Obligatorio: no
** KmsKeyId **
Si `StorageEncrypted` es `true`, el identificador de la clave de AWS KMS para el clúster cifrado.
Tipo: cadena
Requerido: no
** LatestRestorableTime **
Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
Tipo: marca temporal
Obligatorio: no
** MasterUsername **
Contiene el nombre de usuario maestro para el clúster.
Tipo: cadena
Requerido: no
** MasterUserSecret **
El secreto administrado por Amazon DocumentDB en Secrets Manager de AWS para la contraseña del usuario maestro.
Tipo: objeto [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)
Obligatorio: no
** MultiAZ **
Especifica si el clúster tiene instancias en varias zonas de disponibilidad.
Tipo: Booleano
Obligatorio: no
** NetworkType **
El tipo de red del clúster.
El tipo de red viene determinado por el `DBSubnetGroup` especificado para el clúster. Un `DBSubnetGroup` admite solamente el protocolo IPv4 o los protocolos IPv4 e IPv6 (`DUAL`).
Para obtener más información, consulte [Clústeres de DocumentDB en una VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) en la Guía para desarrolladores de Amazon DocumentDB.
Valores válidos: `IPV4` \$1 `DUAL`
Tipo: cadena
Requerido: no
** PercentProgress **
Especifica el progreso de la operación como porcentaje.
Tipo: cadena
Requerido: no
** Port **
Especifica el puerto en el que escucha el motor de la base de datos.
Tipo: entero
Obligatorio: no
** PreferredBackupWindow **
Especifica el intervalo de tiempo diario durante el cual se crean copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas, de acuerdo con la propiedad `BackupRetentionPeriod`.
Tipo: cadena
Requerido: no
** PreferredMaintenanceWindow **
Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
Tipo: cadena
Requerido: no
** ReaderEndpoint **
El punto de conexión del lector para el clúster. El punto de conexión del lector de un clúster equilibra la carga de las conexiones entre las réplicas de Amazon DocumentDB que están disponibles en un clúster. A medida que los clientes solicitan nuevas conexiones al punto de conexión del lector, Amazon DocumentDB distribuye las solicitudes de conexión entre las réplicas de Amazon DocumentDB del clúster. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de Amazon DocumentDB del clúster.
Si se produce una conmutación por error y la réplica de Amazon DocumentDB a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de Amazon DocumentDB del clúster, puede volver a conectarse al punto de conexión del lector.
Tipo: cadena
Requerido: no
** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **
Contiene uno o más identificadores de los clústeres secundarios asociados a este clúster.
Tipo: matriz de cadenas
Obligatorio: no
** ReplicationSourceIdentifier **
Contiene el identificador del clúster de origen si este clúster es secundario.
Tipo: cadena
Requerido: no
** ServerlessV2ScalingConfiguration **
La configuración de escalado de un clúster de Amazon DocumentDB sin servidor.
Tipo: objeto [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)
Obligatorio: no
** Status **
Especifica el estado actual de este clúster de base de datos.
Tipo: cadena
Requerido: no
** StorageEncrypted **
Especifica si el clúster está cifrado.
Tipo: Booleano
Obligatorio: no
** StorageType **
Tipo de almacenamiento asociado al clúster
Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la *Guía para desarrolladores de Amazon DocumentDB*.
Valores válidos para el tipo de almacenamiento: `standard | iopt1`
El valor predeterminado es `standard `
Tipo: cadena
Requerido: no
** VpcSecurityGroups.VpcSecurityGroupMembership.N **
Una lista de grupos de seguridad de la nube privada virtual (VPC) a las que pertenece el clúster.
Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster)