Cluster - Amazon DocumentDB

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

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

Conteúdo

nota

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

adminUserName

O nome do administrador do cluster elástico.

Tipo: string

Obrigatório: Sim

authType

O tipo de autenticação do cluster elástico.

Tipo: string

Valores Válidos: PLAIN_TEXT | SECRET_ARN

Obrigatório: sim

clusterArn

O identificador ARN do cluster elástico.

Tipo: string

Obrigatório: Sim

clusterEndpoint

O URL usado para se conectar ao cluster elástico.

Tipo: string

Obrigatório: Sim

clusterName

O nome do cluster elástico.

Tipo: String

Obrigatório: Sim

createTime

Especifica a hora em que o cluster elástico foi criado, no Tempo Universal Coordenado (UTC).

Tipo: string

Obrigatório: Sim

kmsKeyId

O identificador de chave do KMS a ser usado para criptografar o cluster elástico.

Tipo: string

Obrigatório: Sim

preferredMaintenanceWindow

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

O número de v CPUs atribuído a cada fragmento elástico do cluster. O máximo é 64. Os valores permitidos são 2, 4, 8, 16, 32, 64.

Tipo: Inteiro

Obrigatório: sim

shardCount

O número de fragmentos atribuídos ao cluster elástico. O máximo é 32.

Tipo: inteiro

Obrigatório: sim

status

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 EC2 sub-rede da Amazon IDs para o cluster elástico.

Tipo: matriz de strings

Obrigatório: sim

vpcSecurityGroupIds

Uma lista de grupos de segurança de EC2 VPC associados a esse cluster elástico.

Tipo: matriz de strings

Obrigatório: sim

backupRetentionPeriod

O número de dias durante os quais os snapshots automáticos são retidos.

Tipo: número inteiro

Obrigatório: não

preferredBackupWindow

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

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: número inteiro

Obrigatório: não

shards

O número total de fragmentos no cluster.

Tipo: matriz de objetos Shard

Obrigatório: Não

Consulte também

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: