As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Retorna informações sobre um cluster elástico específico.

## Conteúdo
<a name="API_elastic_Cluster_Contents"></a>

**nota**  
Na lista a seguir, os parâmetros necessários são descritos primeiro.

 ** adminUserName **   <a name="documentdb-Type-elastic_Cluster-adminUserName"></a>
O nome do administrador do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
O tipo de autenticação do cluster elástico.  
Tipo: String  
Valores válidos: `PLAIN_TEXT | SECRET_ARN`   
Obrigatório: Sim

 ** clusterArn **   <a name="documentdb-Type-elastic_Cluster-clusterArn"></a>
O identificador ARN do cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
O URL usado para se conectar ao cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** clusterName **   <a name="documentdb-Type-elastic_Cluster-clusterName"></a>
O nome do cluster elástico.  
Tipo: String  
Obrigatório: Sim

 ** createTime **   <a name="documentdb-Type-elastic_Cluster-createTime"></a>
Especifica a hora em que o cluster elástico foi criado, no Tempo Universal Coordenado (UTC).  
Tipo: string  
Obrigatório: Sim

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
O identificador de chave do KMS a ser usado para criptografar o cluster elástico.  
Tipo: string  
Obrigatório: Sim

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
O intervalo de tempo semanal durante o qual a manutenção do sistema pode ocorrer, no Tempo Universal Coordenado (UTC).  
 *Formato*: `ddd:hh24:mi-ddd:hh24:mi`   
Tipo: string  
Obrigatório: Sim

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
O número de vCPUs atribuídas a cada fragmento de cluster elástico. O máximo é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64.  
Tipo: Inteiro  
Obrigatório: Sim

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
O número de fragmentos atribuídos ao cluster elástico. O máximo é 32.  
Tipo: inteiro  
Obrigatório: Sim

 ** status **   <a name="documentdb-Type-elastic_Cluster-status"></a>
O status do cluster elástico.  
Tipo: String  
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`   
Obrigatório: Sim

 ** subnetIds **   <a name="documentdb-Type-elastic_Cluster-subnetIds"></a>
Os IDs de sub-rede do Amazon EC2 do cluster elástico.  
Tipo: matriz de strings  
Obrigatório: Sim

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_Cluster-vpcSecurityGroupIds"></a>
Uma lista de grupos de segurança da VPC do EC2 associados a esse cluster elástico.  
Tipo: matriz de strings  
Obrigatório: Sim

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
O número de dias durante os quais os snapshots automáticos são retidos.  
Tipo: inteiro  
Obrigatório: Não

 ** preferredBackupWindow **   <a name="documentdb-Type-elastic_Cluster-preferredBackupWindow"></a>
O intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem ativados, conforme determinado por `backupRetentionPeriod`.  
Tipo: String  
Obrigatório: Não

 ** shardInstanceCount **   <a name="documentdb-Type-elastic_Cluster-shardInstanceCount"></a>
O número de instâncias de réplica que se aplicam a todos os fragmentos no cluster. O valor 1 de `shardInstanceCount` significa que há uma instância gravadora, e todas as instâncias adicionais são réplicas que podem ser usadas para leituras e para melhorar a disponibilidade.  
Tipo: inteiro  
Obrigatório: Não

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
O número total de fragmentos no cluster.  
Tipo: matriz de objetos [Shard](API_elastic_Shard.md)  
Obrigatório: Não

## Consulte também
<a name="API_elastic_Cluster_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte:
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK for 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)