UpdateCluster - Amazon DocumentDB
Sintaxe da SolicitaçãoParâmetros da Solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte Também

UpdateCluster

Modifica um cluster elástico. Isso inclui atualizar o nome de usuário/senha do administrador, atualizar a versão da API e configurar uma janela de backup e uma janela de manutenção

Sintaxe da Solicitação

PUT /cluster/clusterArn HTTP/1.1
Content-type: application/json

{
   "adminUserPassword": "string",
   "authType": "string",
   "backupRetentionPeriod": number,
   "clientToken": "string",
   "preferredBackupWindow": "string",
   "preferredMaintenanceWindow": "string",
   "shardCapacity": number,
   "shardCount": number,
   "shardInstanceCount": number,
   "subnetIds": [ "string" ],
   "vpcSecurityGroupIds": [ "string" ]
}

Parâmetros da Solicitação de URI

A solicitação usa os seguintes parâmetros de URI:

clusterArn

O identificador ARN do cluster elástico.

Obrigatório: Sim

Corpo da Solicitação

A solicitação aceita os dados a seguir no formato JSON.

adminUserPassword

A senha associada ao administrador do cluster elástico. Ela pode conter qualquer caractere ASCII imprimível, exceto barra (/), aspas duplas (") ou arroba ("@").

Restrições: deve conter de 8 a 100 caracteres.

Tipo: String

Obrigatório: Não

authType

O tipo de autenticação usado para determinar onde buscar a senha usada para acessar o cluster elástico. Os tipos válidos são PLAIN_TEXT e SECRET_ARN.

Tipo: String

Valores Válidos: PLAIN_TEXT | SECRET_ARN

Obrigatório: Não

backupRetentionPeriod

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

Tipo: número inteiro

Obrigatório: Não

clientToken

O token do cliente para o cluster elástico.

Tipo: String

Obrigatório: Não

preferredBackupWindow

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

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

Padrão: uma janela de 30 minutos selecionada aleatoriamente de um bloco de tempo de 8 horas para cada Região da AWS, ocorrendo em um dia aleatório da semana.

Dias válidos: Seg, Ter, Qua, Qui, Sex, Sáb, Dom

Restrições: janela mínima de 30 minutos.

Tipo: String

Obrigatório: Não

shardCapacity

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: Não

shardCount

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

Tipo: Inteiro

Obrigatório: Não

shardInstanceCount

O número de instâncias de réplica aplicadas a todos os fragmentos no cluster elástico. O valor 1 em shardInstanceCount significa que há uma instância de gravação, 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

subnetIds

Os IDs de sub-rede do Amazon EC2 do cluster elástico.

Tipo: Matriz de strings

Obrigatório: Não

vpcSecurityGroupIds

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

Tipo: Matriz de strings

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200
Content-type: application/json

{
   "cluster": { 
      "adminUserName": "string",
      "authType": "string",
      "backupRetentionPeriod": number,
      "clusterArn": "string",
      "clusterEndpoint": "string",
      "clusterName": "string",
      "createTime": "string",
      "kmsKeyId": "string",
      "preferredBackupWindow": "string",
      "preferredMaintenanceWindow": "string",
      "shardCapacity": number,
      "shardCount": number,
      "shardInstanceCount": number,
      "shards": [ 
         { 
            "createTime": "string",
            "shardId": "string",
            "status": "string"
         }
      ],
      "status": "string",
      "subnetIds": [ "string" ],
      "vpcSecurityGroupIds": [ "string" ]
   }
}

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.

Os dados a seguir são retornados no formato JSON pelo serviço.

cluster

Retorna informações sobre o cluster elástico atualizado.

Tipo: objeto Cluster

Erros

Para obter informações sobre os erros comuns a todas ações, consulte Erros comuns.

AccessDeniedException

Uma exceção que ocorre quando não há permissões suficientes para realizar uma ação.

Código de Status HTTP: 403

ConflictException

Houve um conflito de acesso.

Código de Status HTTP: 409

InternalServerException

Ocorreu um erro interno no servidor.

Código de Status HTTP: 500

ResourceNotFoundException

O recurso especificado não foi localizado.

Código de Status HTTP: 404

ThrottlingException

ThrottlingException será lançada quando a solicitação for negada devido à limitação da solicitação.

Código de Status HTTP: 429

ValidationException

Uma estrutura que define uma exceção de validação.

Código de Status HTTP: 400

Consulte Também

Para obter mais informações sobre como usar essa API em um dos SDKs específicos de linguagem AWS, consulte: