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.

# Cluster
<a name="API_elastic_Cluster"></a>

Devuelve información sobre un clúster elástico específico.

## Contenido
<a name="API_elastic_Cluster_Contents"></a>

**nota**  
Los parámetros obligatorios se describen primero en la siguiente tabla.

 ** adminUserName **   <a name="documentdb-Type-elastic_Cluster-adminUserName"></a>
El nombre del administrador de los clústeres elásticos.  
Tipo: cadena  
Obligatorio: sí

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
El tipo de autenticación del clúster elástico.  
Tipo: cadena  
Valores válidos: `PLAIN_TEXT | SECRET_ARN`   
Obligatorio: sí

 ** clusterArn **   <a name="documentdb-Type-elastic_Cluster-clusterArn"></a>
El identificador ARN del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
La URL que se usa para conectarse al clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** clusterName **   <a name="documentdb-Type-elastic_Cluster-clusterName"></a>
El nombre del clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** createTime **   <a name="documentdb-Type-elastic_Cluster-createTime"></a>
La hora a la que se creó el clúster elástico, en tiempo universal coordinado (UTC).  
Tipo: cadena  
Obligatorio: sí

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
El identificador de clave de KMS que se debe utilizar para cifrar el clúster elástico.  
Tipo: cadena  
Obligatorio: sí

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).  
 *Formato*: `ddd:hh24:mi-ddd:hh24:mi`   
Tipo: cadena  
Obligatorio: sí

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
La cantidad de vCPU asignadas a cada partición de clúster elástico. El máximo es 64. Los valores permitidos son 2, 4, 8, 16, 32, 64.  
Tipo: número entero  
Obligatorio: sí

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
El número de particiones asignadas al clúster elástico. El máximo es 32.  
Tipo: número entero  
Obligatorio: sí

 ** status **   <a name="documentdb-Type-elastic_Cluster-status"></a>
Estado del clúster elástico.  
Tipo: cadena  
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`   
Obligatorio: sí

 ** subnetIds **   <a name="documentdb-Type-elastic_Cluster-subnetIds"></a>
Los ID de subredes de Amazon EC2 para el clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: sí

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_Cluster-vpcSecurityGroupIds"></a>
Una lista de grupos de seguridad de VPC de EC2 para asociar a este clúster elástico.  
Tipo: matriz de cadenas  
Obligatorio: sí

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
El número de días durante los que se conservan las instantáneas de base de datos automáticas.  
Tipo: entero  
Obligatorio: no

 ** preferredBackupWindow **   <a name="documentdb-Type-elastic_Cluster-preferredBackupWindow"></a>
El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas según lo determina `backupRetentionPeriod`.  
Tipo: cadena  
Requerido: no

 ** shardInstanceCount **   <a name="documentdb-Type-elastic_Cluster-shardInstanceCount"></a>
El número de instancias de réplica que se aplica a todas las particiones del clúster. Un valor de `shardInstanceCount` igual a 1 significa que hay una instancia de escritura y las instancias adicionales son réplicas que se pueden usar para llevar a cabo lecturas y mejorar la disponibilidad.  
Tipo: entero  
Obligatorio: no

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
El número total de particiones en el clúster.  
Tipo: matriz de objetos [Shard](API_elastic_Shard.md)  
Obligatorio: no

## Véase también
<a name="API_elastic_Cluster_SeeAlso"></a>

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-elastic-2022-11-28/Cluster) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster)