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 obrigatórios são descritos primeiro.
- AssociatedRoles.DBClusterRole.N
-
Fornece uma lista das funções AWS Identity and Access Management (IAM) associadas ao cluster. As funções (IAM) associadas a um cluster concedem permissão para que o cluster acesse outros AWS serviços em seu nome.
Tipo: matriz de objetos DBClusterRole
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: sequência
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: sequência
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: sequência
Obrigatório: não
- DBClusterMembers.DBClusterMember.N
-
Fornece a lista de instâncias que compõem o cluster.
Tipo: matriz de objetos DBClusterMember
Obrigatório: não
- DBClusterParameterGroup
-
Especifica o nome do grupo de parâmetros do cluster para o cluster.
Tipo: sequência
Obrigatório: não
- DbClusterResourceId
-
O identificador Região da AWS exclusivo e imutável do cluster. Esse identificador é encontrado nas entradas de AWS CloudTrail registro sempre que a AWS KMS chave do cluster é acessada.
Tipo: sequência
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: sequência
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 eDeletionProtection
esteja desabilitado.DeletionProtection
protege clusters contra exclusão acidental.Tipo: booliano
Obrigatório: não
- EarliestRestorableTime
-
A primeira vez em que um banco de dados pode ser restaurado com point-in-time a restauração.
Tipo: carimbo de data/hora
Obrigatório: não
- EnabledCloudwatchLogsExports.member.N
-
Uma lista dos tipos de log 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: sequência
Obrigatório: não
- EngineVersion
-
Indica a versão do mecanismo do banco de dados.
Tipo: sequência
Obrigatório: não
- HostedZoneId
-
Especifica o ID que o Amazon Route 53 atribui ao criar uma zona hospedada.
Tipo: sequência
Obrigatório: não
- KmsKeyId
-
Se
StorageEncrypted
fortrue
, o identificador da AWS KMS chave para o cluster criptografado.Tipo: sequência
Obrigatório: não
- LatestRestorableTime
-
Especifica a última hora na qual um banco de dados pode ser restaurado com a point-in-time restauração.
Tipo: carimbo de data/hora
Obrigatório: não
- MasterUsername
-
Contém o nome de usuário mestre para o cluster.
Tipo: sequência
Obrigatório: não
- MultiAZ
-
Especifica se o cluster tem instâncias em várias zonas de disponibilidade.
Tipo: booliano
Obrigatório: não
- PercentProgress
-
Especifica o andamento da operação como uma porcentagem.
Tipo: sequência
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: sequência
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: sequência
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: sequência
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: sequência
Obrigatório: não
- Status
-
Especifica o estado atual desse cluster.
Tipo: sequência
Obrigatório: não
- StorageEncrypted
-
Especifica se o cluster é criptografado.
Tipo: booliano
Obrigatório: não
- StorageType
-
Tipo de armazenamento associado ao seu cluster
Tipo de armazenamento associado ao seu 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: sequência
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
Obrigatório: não
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: