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á.
# DBCluster
Informações detalhadas sobre um cluster.
## Conteúdo
**nota**
Na lista a seguir, os parâmetros necessários são descritos primeiro.
** AssociatedRoles.DBClusterRole.N **
Fornece uma lista dos perfis (IAM) do AWS Identity and Access Management que estão associadas ao cluster. Os perfis (IAM) associados a uma permissão de concessão do cluster para acessar outros serviços da AWS em seu nome.
Tipo: matriz de objetos [DBClusterRole](API_DBClusterRole.md)
Obrigatório: Não
** AvailabilityZones.AvailabilityZone.N **
Fornece a lista de zonas de disponibilidade do Amazon EC2 nas quais as instâncias no cluster podem ser criadas.
Tipo: matriz de strings
Obrigatório: Não
** BackupRetentionPeriod **
Especifica o número de dias durante os quais os snapshots automáticos são retidos.
Tipo: inteiro
Obrigatório: Não
** CloneGroupId **
Identifica o grupo de clones ao qual o cluster do banco de dados está associado.
Tipo: String
Obrigatório: Não
** ClusterCreateTime **
Especifica a hora em que o cluster foi criado, no Tempo Universal Coordenado (UTC).
Tipo: carimbo de hora
Obrigatório: Não
** DBClusterArn **
O nome de recurso da Amazon (ARN) para o cluster.
Tipo: String
Obrigatório: Não
** DBClusterIdentifier **
Contém um identificador de cluster fornecido pelo usuário. Esse identificador é a chave exclusiva que identifica um cluster.
Tipo: String
Obrigatório: Não
** DBClusterMembers.DBClusterMember.N **
Fornece a lista de instâncias que compõem o cluster.
Tipo: matriz de objetos [DBClusterMember](API_DBClusterMember.md)
Obrigatório: Não
** DBClusterParameterGroup **
Especifica o nome do grupo de parâmetros do cluster para o cluster.
Tipo: String
Obrigatório: Não
** DbClusterResourceId **
O identificador imutável e exclusivo da Região da AWS para o cluster. Esse identificador é encontrado nas entradas de log do AWS CloudTrail sempre que a chave do AWS KMS para o cluster é acessada.
Tipo: String
Obrigatório: Não
** DBSubnetGroup **
Especifica informações sobre o grupo de sub-redes associado ao cluster, incluindo o nome, a descrição e as sub-redes no grupo de sub-redes.
Tipo: String
Obrigatório: Não
** DeletionProtection **
Especifica se esse cluster pode ser excluído. Se `DeletionProtection` estiver ativado, o cluster não pode ser excluído, a menos que seja modificado e `DeletionProtection` esteja desabilitado. `DeletionProtection` protege clusters contra exclusão acidental.
Tipo: booliano
Obrigatório: Não
** EarliestRestorableTime **
Especifica a data mais antiga para a qual um banco de dados pode ser restaurado com restauração ponto no tempo.
Tipo: Timestamp
Obrigatório: Não
** EnabledCloudwatchLogsExports.member.N **
Uma lista de tipos de logs que esse cluster está configurado para exportar para o Amazon CloudWatch Logs.
Tipo: matriz de strings
Obrigatório: Não
** Endpoint **
Especifica o endpoint de conexão para a instância principal do cluster.
Tipo: string
Obrigatório: Não
** Engine **
Fornece o nome do mecanismo de banco de dados a ser usado para esse cluster.
Tipo: String
Obrigatório: Não
** EngineVersion **
Indica a versão do mecanismo do banco de dados.
Tipo: String
Obrigatório: Não
** HostedZoneId **
Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.
Tipo: String
Obrigatório: Não
** IOOptimizedNextAllowedModificationTime **
Na próxima vez será possível modificar o cluster do Amazon DocumentDB para usar o tipo de armazenamento iopt1.
Tipo: Timestamp
Obrigatório: Não
** KmsKeyId **
Se `StorageEncrypted` for `true`, o identificador da chave AWS KMS para o cluster criptografado.
Tipo: String
Obrigatório: Não
** LatestRestorableTime **
Especifica a data mais recente até a qual um banco de dados pode ser restaurado com restauração pontual.
Tipo: carimbo de hora
Obrigatório: Não
** MasterUsername **
Contém o nome de usuário principal para o cluster.
Tipo: String
Obrigatório: Não
** MasterUserSecret **
O segredo gerenciado pelo Amazon DocumentDB no AWS Secrets Manager para a senha do usuário principal.
Tipo: objeto [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)
Obrigatório: Não
** MultiAZ **
Especifica se o cluster tem instâncias em várias zonas de disponibilidade.
Tipo: booliano
Obrigatório: Não
** NetworkType **
O tipo de rede do cluster.
O tipo de rede é determinado usando o `DBSubnetGroup` especificado para o cluster. Um `DBSubnetGroup` pode oferecer suporte somente para o protocolo IPv4 ou para os protocolos IPv4 e IPv6 (`DUAL`).
Para obter mais informações, consulte [Clusters do DocumentDB em uma VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) no Guia do desenvolvedor do Amazon DocumentDB.
Valores válidos: `IPV4` \$1 `DUAL`
Tipo: String
Obrigatório: Não
** PercentProgress **
Especifica o andamento da operação como um percentual.
Tipo: String
Obrigatório: Não
** Port **
Especifica a porta onde o mecanismo de banco de dados está realizando a recepção.
Tipo: inteiro
Obrigatório: Não
** PreferredBackupWindow **
Especifica o intervalo de tempo diário durante o qual os backups automatizados serão criados se eles estiverem habilitados, conforme determinado por `BackupRetentionPeriod`.
Tipo: String
Obrigatório: Não
** PreferredMaintenanceWindow **
Especifica o período semanal durante o qual pode ocorrer a manutenção do sistema, em Tempo Universal Coordenado (UTC).
Tipo: String
Obrigatório: Não
** ReaderEndpoint **
O endpoint do leitor do cluster. O endpoint do leitor para balanceadores de carga do cluster das conexões entre réplicas do Amazon DocumentDB que estão disponíveis em um cluster. À medida em que os clientes solicitam novas conexões ao endpoint do leitor, o Amazon DocumentDB distribui as solicitações de conexão entre as réplicas de Amazon DocumentDB no cluster. Essa funcionalidade pode ajudar a equilibrar sua workload de leitura entre várias réplicas do Amazon DocumentDB em seu cluster.
Se ocorrer um failover e a réplica do Amazon DocumentDB à qual você estiver conectado for promovida à instância principal, a sua conexão será interrompida. Para continuar a enviar sua workload de leitura para outras réplicas do Amazon DocumentDB no cluster, reconecte-se ao endpoint do leitor.
Tipo: String
Obrigatório: Não
** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **
Contém um ou mais identificadores dos clusters secundários associados a esse cluster.
Tipo: matriz de strings
Obrigatório: Não
** ReplicationSourceIdentifier **
Contém o identificador do cluster de origem, se esse cluster for um cluster secundário.
Tipo: String
Obrigatório: Não
** ServerlessV2ScalingConfiguration **
A configuração de escalabilidade de um cluster do Amazon DocumentDB Sem Servidor.
Tipo: objeto [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)
Obrigatório: Não
** Status **
Especifica o estado atual desse cluster.
Tipo: String
Obrigatório: Não
** StorageEncrypted **
Especifica se o cluster é criptografado.
Tipo: booliano
Obrigatório: Não
** StorageType **
Tipo de armazenamento associado ao cluster
Para obter informações sobre os tipos de armazenamento para clusters do Amazon DocumentDB, consulte Configurações de armazenamento em cluster no *Guia do desenvolvedor do Amazon DocumentDB*.
Valores válidos para o tipo de armazenamento - `standard | iopt1`
O valor padrão é . `standard `
Tipo: String
Obrigatório: Não
** VpcSecurityGroups.VpcSecurityGroupMembership.N **
Uma lista de grupos de segurança da nuvem privada virtual (VPC) a serem associados ao que o cluster pertence.
Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)
Obrigatório: Não
## Consulte também
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-2014-10-31/DBCluster)
+ [AWS SDK for 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)