Modificando os parâmetros de cluster do Amazon DocumentDB

No Amazon DocumentDB, os grupos de parâmetros de cluster consistem em parâmetros que se aplicam a todas as instâncias criadas no cluster. Para grupos de parâmetros de cluster personalizados, é possível modificar um valor de parâmetro a qualquer momento, ou redefinir todos os valores de parâmetro como padrão para os grupos de parâmetros criados. Esta seção descreve como visualizar os parâmetros e valores de um grupo de parâmetros de cluster do Amazon DocumentDB, além de mostrar como alterar ou atualizar esses valores.

Os parâmetros podem ser dinâmicos ou estáticos. Ao alterar um parâmetro dinâmico e salvar o grupo de parâmetros de cluster, a alteração é aplicada imediatamente, independente da configuração Apply Immediately. Quando você altera um parâmetro estático e salva o grupo de parâmetros do cluster, a alteração do parâmetro entra em vigor depois que você reinicia manualmente a instância do cluster.

Visualizando os parâmetros de um grupo de parâmetros de cluster do Amazon DocumentDB

Você pode visualizar os parâmetros de um cluster do Amazon DocumentDB e seus valores usando AWS Management Console ou AWS CLI.

Using the AWS Management Console

Para visualizar os detalhes de um grupos de parâmetros de cluster

1. Faça login no AWS Management Console e abra o console do Amazon DocumentDB em https://console.aws.amazon.com/emr/clusters.

2. No painel de navegação, escolha Grupos de parâmetros.

   dica

   Caso não visualize o painel de navegação à esquerda da tela, selecione o ícone do menu () no canto superior esquerdo da página.

3. No painel grupos de parâmetro, escolha o nome do grupo de parâmetro do cluster cujos detalhes deseja visualizar.

4. A página resultante exibe os seguintes valores para cada parâmetro: o nome, o valor atual, os valores permitidos, se o parâmetro é modificável, o tipo de aplicação, o tipo de dado e a descrição.

   

Using the AWS CLI

Para ver os parâmetros de um grupos de parâmetros de cluster e seus valores, use a operação describe-db-cluster-parameters com os seguintes parâmetros.

• --db-cluster-parameter-group-name — obrigatório. O nome do grupos de parâmetros de cluster cuja lista detalhada de parâmetros você deseja.

• --source — Opcional. Se fornecido, retorna apenas parâmetros para uma origem específica. As origens de parâmetros podem ser engine-default, system ou user.

O código a seguir lista os parâmetros e seus valores para o grupo de parâmetros custom3-6-param-grp. Para obter mais informações sobre o grupo de parâmetros, omita a linha --query. Para obter informações sobre todos os grupos de parâmetros, omita a linha --db-cluster-parameter-group-name.

Para Linux, macOS ou Unix:

aws docdb describe-db-cluster-parameters \
   --db-cluster-parameter-group-name custom3-6-param-grp \
   --query 'Parameters[*].[ParameterName,ParameterValue]'

Para Windows:

aws docdb describe-db-cluster-parameters ^
   --db-cluster-parameter-group-name custom3-6-param-grp ^
   --query 'Parameters[*].[ParameterName,ParameterValue]'

A saída dessa operação é semelhante ao seguinte (formato JSON).

[
    [
        "audit_logs",
        "disabled"
    ],
    [
        "tls",
        "enabled"
    ],
    [
        "ttl_monitor",
        "enabled"
    ]
]

Modificando parâmetros de um grupo de parâmetros de cluster do Amazon DocumentDB

É possível modificar os parâmetros de um grupo de parâmetros usando o AWS Management Console ou AWS CLI.

Using the AWS Management Console

Como atualizar os parâmetros de um grupo de parâmetros de cluster

1. Faça login no AWS Management Console e abra o console do Amazon DocumentDB em https://console.aws.amazon.com/emr/clusters.

2. No painel de navegação, escolha Grupos de parâmetros.

   dica

   Caso não visualize o painel de navegação à esquerda da tela, selecione o ícone do menu () no canto superior esquerdo da página.

3. No painel Grupos de parâmetros, selecione um grupo de parâmetros do cluster cujos parâmetros deseja atualizar.

4. A página resultante mostra os parâmetros e os detalhes correspondentes para este grupo de parâmetros do cluster. Selecione um parâmetro para atualizar.

5. No canto superior direito da página, selecione Editar para alterar o valor do parâmetro. Para obter mais informações sobre os tipos de parâmetros de cluster, consulte Referência de parâmetros de cluster do Amazon DocumentDB.

6. Faça a alteração e escolha Modificar parâmetro de cluster para salvar as alterações. Para descartar as alterações, escolha Cancelar.

Using the AWS CLI

Para modificar os parâmetros de um grupo de parâmetros de cluster, use a operação modify-db-cluster-parameter-group com os parâmetros a seguir:

• --db-cluster-parameter-group-name — obrigatório. O nome do grupos de parâmetros de cluster que você está modificando.

• --parameters — obrigatório. O parâmetro ou os parâmetros que você está modificando. Cada entrada de parâmetro deve incluir o seguinte:

  • ParameterName — O nome do parâmetro que você está modificando.

  • ParameterValue — o novo valor para esse parâmetro.

  • ApplyMethod — como você deseja aplicar as alterações nesse parâmetro. Os valores permitidos são immediate e pending-reboot.

    nota

    Os parâmetros com ApplyType de static devem ter um ApplyMethod de pending-reboot.

Como alterar os valores dos parâmetros de um grupo de parâmetros de cluster (AWS CLI)

O exemplo a seguir altera o parâmetro tls.

1. Liste os parâmetros e os valores do sample-parameter-group

   Para Linux, macOS ou Unix:

   aws docdb describe-db-cluster-parameters \
       --db-cluster-parameter-group-name sample-parameter-group

   Para Windows:

   aws docdb describe-db-cluster-parameters ^
       --db-cluster-parameter-group-name sample-parameter-group

   A saída dessa operação é semelhante ao seguinte (formato JSON).

   {
       "Parameters": [
           {
               "Source": "system",
               "ApplyType": "static",
               "AllowedValues": "disabled,enabled",
               "ParameterValue": "enabled",
               "ApplyMethod": "pending-reboot",
               "DataType": "string",
               "ParameterName": "tls",
               "IsModifiable": true,
               "Description": "Config to enable/disable TLS"
           },
           {
               "Source": "user",
               "ApplyType": "dynamic",
               "AllowedValues": "disabled,enabled",
               "ParameterValue": "enabled",
               "ApplyMethod": "pending-reboot",
               "DataType": "string",
               "ParameterName": "ttl_monitor",
               "IsModifiable": true,
               "Description": "Enables TTL Monitoring"
           }
       ]
   }

2. Modifique o parâmetro tls para que seu valor seja disabled. Não é possível modificar o ApplyMethod porque o ApplyType é static.

   Para Linux, macOS ou Unix:

   aws docdb modify-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group \
       --parameters "ParameterName"=tls,ParameterValue=disabled,ApplyMethod=pending-reboot"

   Para Windows:

   aws docdb modify-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group ^
       --parameters "ParameterName=tls,ParameterValue=disabled,ApplyMethod=pending-reboot"

   A saída dessa operação é semelhante ao seguinte (formato JSON).

   {
       "DBClusterParameterGroupName": "sample-parameter-group"
   }

3. Aguarde pelo menos 5 minutos.

4. Liste os valores dos parâmetros do sample-parameter-group.

   Para Linux, macOS ou Unix:

   aws docdb describe-db-cluster-parameters \
       --db-cluster-parameter-group-name sample-parameter-group

   Para Windows:

   aws docdb describe-db-cluster-parameters ^
       --db-cluster-parameter-group-name sample-parameter-group

   A saída dessa operação é semelhante ao seguinte (formato JSON).

   {
       "Parameters": [
           {
               "ParameterName": "audit_logs",
               "ParameterValue": "disabled",
               "Description": "Enables auditing on cluster.",
               "Source": "system",
               "ApplyType": "dynamic",
               "DataType": "string",
               "AllowedValues": "enabled,disabled",
               "IsModifiable": true,
               "ApplyMethod": "pending-reboot"
           },
           {
               "ParameterName": "tls",
               "ParameterValue": "disabled",
               "Description": "Config to enable/disable TLS",
               "Source": "user",
               "ApplyType": "static",
               "DataType": "string",
               "AllowedValues": "disabled,enabled",
               "IsModifiable": true,
               "ApplyMethod": "pending-reboot"
           }
       ]
   }