

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á.

# Gerenciando grupos de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups"></a>

É possível gerir a configuração do mecanismo do Amazon DocumentDB usando parâmetros em um grupo de parâmetros de cluster. Um *grupo de parâmetros de cluster* é um conjunto de valores de configuração do Amazon DocumentDB que facilita o gerenciamento dos parâmetros de seus clusters do Amazon DocumentDB. Grupos de parâmetro de cluster atuam como contêiner de valores de configuração de mecanismo que são aplicados a todas as instâncias no cluster. 

Esta seção descreve como criar, exibir e modificar grupos de parâmetros de cluster. Ele também mostra como é possível determinar qual grupo de parâmetros de cluster está associado a um determinado cluster.

**Topics**
+ [Descrevendo grupos de parâmetros de cluster](cluster_parameter_groups-describe.md)
+ [Criando grupos de parâmetros de cluster](cluster_parameter_groups-create.md)
+ [Modificando grupos de parâmetros de cluster](cluster_parameter_groups-modify.md)
+ [Modificando clusters para usar grupos de parâmetros de cluster personalizados](cluster_parameter_groups-modify_clusters.md)
+ [Copiando grupos de parâmetros de cluster](cluster_parameter_groups-copy.md)
+ [Redefinindo grupos de parâmetros de cluster](cluster_parameter_groups-reset.md)
+ [Excluindo grupos de parâmetros de cluster](cluster_parameter_groups-delete.md)
+ [Referência de parâmetros de cluster](cluster_parameter_groups-list_of_parameters.md)

# Descrever os grupos de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-describe"></a>

Um grupo de parâmetros de cluster `default` é criado automaticamente quando você cria o primeiro cluster Amazon DocumentDB na nova região ou usa um novo mecanismo. Os clusters subsequentes, criados na mesma região e com a mesma versão do mecanismo, são criados com o grupo de parâmetros do cluster `default`.

**Topics**
+ [Descrevendo os detalhes de um grupo de parâmetros de cluster](#cluster_parameter_groups-describe_details)
+ [Determinando um grupo de parâmetros de um cluster](#cluster_parameter_groups-determine)
+ [Determinação de clusters e instâncias associados a um grupo de parâmetros de cluster](#cluster_parameter_groups-count)

## Descrevendo os detalhes de um grupo de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-describe_details"></a>

Para descrever os detalhes de um determinado grupo de parâmetros de cluster, conclua as etapas a seguir usando o Console de gerenciamento da AWS ou o AWS Command Line Interface (AWS CLI).

------
#### [ Using the Console de gerenciamento da AWS ]

****

1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-menu-icon.png)) no canto superior esquerdo da página.

1. No painel **Grupos de parâmetros de cluster**, escolha o nome do grupo de parâmetros de cluster cujos detalhes deseja visualizar.

1. A página resultante exibe os parâmetros do grupo de parâmetros, a atividade recente e as tags.
   + Em **Parâmetros de cluster**, é possível ver o nome do parâmetro, 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. É possível modificar parâmetros individuais selecionando o parâmetro e escolhendo **Editar** na seção **Parâmetros de cluster**. Para obter mais informações, consulte [Modificando os parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups-parameters.md).
   + Em **Eventos recentes**, é possível ver os eventos mais recentes para esse grupo de parâmetros. É possível filtrar esses eventos usando a barra de pesquisa nesta seção. Para obter mais informações, consulte [Gerenciando eventos do Amazon DocumentDB](managing-events.md).
   + Em **Tags**, você pode ver as tags nesse grupo de parâmetro do cluster. É possível adicionar ou remover tags escolhendo **Editar** na seção **Tags**. Para obter mais informações, consulte [Marcação de recursos do Amazon DocumentDB](tagging.md).

------
#### [ Using the AWS CLI ]

Você pode usar o `describe-db-cluster-parameter-groups` AWS CLI comando para visualizar o Amazon Resource Name (ARN), a família, a descrição e o nome de um único grupo de parâmetros de cluster ou de todos os grupos de parâmetros de cluster que você tem para o Amazon DocumentDB. Você também pode usar o `describe-db-cluster-parameters` AWS CLI comando para visualizar os parâmetros e seus detalhes dentro de um único grupo de parâmetros do cluster.
+ **--describe-db-cluster-parameter-groups** — para ver uma lista de todos os grupos de parâmetros de cluster e seus detalhes.
  + **--db-cluster-parameter-group-name** — Opcional. O nome do grupo de parâmetro de cluster que você deseja descrever. Se esse parâmetro for omitido, todos os grupos de parâmetro de cluster serão descritos.
+ **--describe-db-cluster-parameters** — para listar todos os parâmetros em um grupo de parâmetros e seus valores.
  + **--db-cluster-parameter-group name** — obrigatório. O nome do grupo de parâmetro de cluster que você deseja descrever.

**Example**  
O código a seguir lista até 100 grupos de parâmetros de cluster e seus ARNs, famílias, descrições e nomes.  

```
aws docdb describe-db-cluster-parameter-groups
```
A saída dessa operação é semelhante ao seguinte (formato JSON).  

```
{
          "DBClusterParameterGroups": [
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:default.docdb4.0",
                  "DBParameterGroupFamily": "docdb4.0",
                  "Description": "Default cluster parameter group for docdb4.0",
                  "DBClusterParameterGroupName": "default.docdb4.0"
              },
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:012345678912:cluster-pg:sample-parameter-group",
                  "DBParameterGroupFamily": "docdb4.0",
                  "Description": "Custom docdb4.0 parameter group",
                  "DBClusterParameterGroupName": "sample-parameter-group"
              }
          ]
}
```

**Example**  
O código a seguir lista o ARN, a família, a descrição e o nome do `sample-parameter-group`.  
Para Linux, macOS ou Unix:  

```
aws docdb describe-db-cluster-parameter-groups \
          --db-cluster-parameter-group-name sample-parameter-group
```
Para Windows:  

```
aws docdb describe-db-cluster-parameter-groups ^
          --db-cluster-parameter-group-name sample-parameter-group
```
A saída dessa operação é semelhante ao seguinte (formato JSON).  

```
{
          "DBClusterParameterGroups": [
              {
                  "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-parameter-group",
                  "Description": "Custom docdb4.0 parameter group",
                  "DBParameterGroupFamily": "docdb4.0",
                  "DBClusterParameterGroupName": "sample-parameter-group"
              }
          ]
}
```

**Example**  
O código a seguir lista os valores dos parâmetros no `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": "change_stream_log_retention_duration",
            "ParameterValue": "17777",
            "Description": "Duration of time in seconds that the change stream log is retained and can be consumed.",
            "Source": "user",
            "ApplyType": "dynamic",
            "DataType": "integer",
            "AllowedValues": "3600-86400",
            "IsModifiable": true,
            "ApplyMethod": "pending-reboot"
         }
   ]
}
```

------

## Determinando o grupo de parâmetros de um cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-determine"></a>

Para determinar qual grupo de parâmetros está associado a um determinado cluster, conclua as etapas a seguir usando o Console de gerenciamento da AWS ou AWS CLI o. 

------
#### [ Using the Console de gerenciamento da AWS ]

1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)

1. No painel de navegação à esquerda, escolha **Clusters**.

1. Na lista de clusters, selecione o nome do cluster desejado.

1. A página resultante exibe os detalhes do cluster selecionado. Role para baixo até **Detalhes do cluster**. Na parte inferior dessa seção, localize o nome do grupo de parâmetros sob **Grupo de parâmetros de cluster**.  
![\[Captura de tela: como mostrar um grupo de parâmetros de um cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-determine-parameter-group.png)

------
#### [ Using the AWS CLI ]

O AWS CLI código a seguir determina qual grupo de parâmetros está governando o cluster`sample-cluster`.

```
aws docdb describe-db-clusters \
      --db-cluster-identifier sample-cluster \
      --query 'DBClusters[*].[DBClusterIdentifier,DBClusterParameterGroup]'
```

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

```
[
       [
           "sample-cluster",
           "sample-parameter-group"
       ]
]
```

------

## Determinação de clusters e instâncias associados a um grupo de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-count"></a>

Para determinar quantos clusters e instâncias estão associados a cada grupo de parâmetros, conclua as etapas a seguir usando AWS CLI o.

------
#### [ Using the AWS CLI ]

O AWS CLI código a seguir determina a quantos clusters e instâncias estão associados`sample-parameter-group`.

Para Linux, macOS ou Unix:

```
aws docdb describe-db-clusters \
      --query 'DBClusters[*].[DBClusterParameterGroup,DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]' \
      --output json | \
      jq -r 'group_by(.[0]) | map({
         parameter_group_name: .[0][0],
         total_clusters: length,
         total_instances: map(.[2] | length) | add // 0
      }) | .[]'
```

Para Windows:

```
aws docdb describe-db-clusters ^
      --query 'DBClusters[*].[DBClusterParameterGroup,DBClusterIdentifier,DBClusterMembers[*].DBInstanceIdentifier]' ^
      --output json | ^
      jq -r 'group_by(.[0]) | map({
         parameter_group_name: .[0][0],
         total_clusters: length,
         total_instances: map(.[2] | length) | add // 0
      }) | .[]'
```

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

```
{
   "parameter_group_name": "sample-parameter-group",
   "total_clusters": 50,
   "total_instances": 150
}
```

------

# Criando grupos de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-create"></a>

Grupos de parâmetros de cluster padrão, como `default.docdb5.0`, `default.docdb4.0`, ou `default.docdb3.6`, são criados quando você cria um cluster com uma nova versão do mecanismo em uma nova região. Os clusters subsequentes criados nessa região com a mesma versão do mecanismo herdam o grupo de parâmetros do cluster `default`. Depois de criados, os grupos de parâmetros `default` não podem ser excluídos nem renomeados. É possível modificar o comportamento do mecanismo das instâncias de cluster criando um grupo de parâmetros personalizado com valores de parâmetros preferenciais e anexando-o ao seu cluster do Amazon DocumentDB. 

O procedimento a seguir orienta na criação de um grupo de parâmetros de cluster personalizado com base na família. Depois disso, é possível [modificar os parâmetros desse grupo de parâmetros](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-modify.html).

**nota**  
Depois de modificar um grupo de parâmetros de cluster, é necessário esperar pelo menos 5 minutos antes de usar esse grupo de parâmetros em particular. Isso permite que o Amazon DocumentDB conclua a ação `create` integralmente antes que o grupo de parâmetros de cluster seja usado para um novo cluster. Você pode usar a `describe-db-cluster-parameter-groups` AWS CLI operação Console de gerenciamento da AWS ou a para verificar se o grupo de parâmetros do cluster foi criado. Para obter mais informações, consulte [Descrever os grupos de parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups-describe.md).

------
#### [ Using the Console de gerenciamento da AWS ]

**Para criar um grupos de parâmetros de cluster**

1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-menu-icon.png)) no canto superior esquerdo da página.

1. No painel **Grupos de parâmetros de cluster**, escolha **Criar**.

1. No painel **Criar grupo de parâmetros do cluster** insira o seguinte:

   1. **Nome do grupo de parâmetros do novo cluster**: insira um nome para o grupo de parâmetros do cluster. Por exemplo, .`sample-parameter-group` Os grupos de parâmetros de cluster têm as seguintes restrições de nomenclatura:
      + O tamanho é de [1–255] caracteres alfanuméricos.
      + O primeiro caractere deve ser uma letra.
      + Não pode terminar com um hífen ou conter dois hifens consecutivos.

   1. **Família**: escolha uma versão do DocumentDB que você pretende usar para seu cluster.

   1. **Descrição** — fornece uma descrição para este grupo de parâmetros de cluster.

1. Para criar o grupo de parâmetro de cluster, escolha **Criar**. Para cancelar a operação, escolha **Cancelar**.

1. Depois de escolher **Criar**, o texto a seguir será exibido na parte superior da página, para verificar se o grupo de parâmetros de cluster foi criado com êxito:

   ```
   Successfully created cluster parameter group 'sample-parameter-group'.
   ```

------
#### [ Using the AWS CLI ]

Para criar um novo grupo de parâmetros de cluster para clusters do Amazon DocumentDB 4.0, use a AWS CLI `create-db-cluster-parameter-group` operação com os seguintes parâmetros:
+ **--db-cluster-parameter-group-name** — o nome do grupo de parâmetros de cluster personalizado. Por exemplo, .`sample-parameter-group`
+ **--db-cluster-parameter-group-family** — a família do grupo de parâmetros de cluster usada como modelo para o grupo de parâmetros de cluster personalizado.
+ **--description** — a descrição fornecida pelo usuário para esse grupo de parâmetros de cluster. O exemplo a seguir usa "`Custom docdb4.0 parameter group`".

Para Linux, macOS ou Unix:

**Example**  

```
aws docdb create-db-cluster-parameter-group \
 --db-cluster-parameter-group-name sample-parameter-group \
 --db-parameter-group-family docdb5.0 \
 --description "Custom docdb5.0 parameter group"
```
Para Windows:  

```
aws docdb create-db-cluster-parameter-group ^
 --db-cluster-parameter-group-name sample-parameter-group ^
 --db-parameter-group-family docdb5.0 ^
 --description "Custom docdb5.0 parameter group"
```
A saída dessa operação é semelhante ao seguinte (formato JSON).  

```
{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupName": "sample-parameter-group",
        "DBParameterGroupFamily": "docdb5.0",
        "Description": "Custom docdb4.0 parameter group",
        "DBClusterParameterGroupArn": "sample-parameter-group-arn"
    }
}
```

------

# Modificando grupos de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-modify"></a>

Esta seção explica como modificar um grupo de parâmetros *personalizado* do Amazon DocumentDB. No Amazon DocumentDB, você não pode modificar um grupo de parâmetros de cluster `default` ao criar pela primeira vez um cluster com a nova versão do mecanismo em uma nova região. Se o cluster do Amazon DocumentDB estiver usando o grupo de parâmetros de cluster padrão e você desejar modificar um valor, primeiro será necessário [criar um novo grupo de parâmetros](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-create.html), ou [copiar um grupo de parâmetros existente](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-copy.html), para então modificá-lo e, em seguida, aplicar o grupo de parâmetros modificado ao seu cluster.

Conclua as etapas a seguir para modificar um grupo personalizado de parâmetros de cluster. As ações de modificação podem demorar um pouco para se propagar. Aguarde até que o grupo de parâmetros de cluster modificado esteja disponível antes de anexá-lo ao seu cluster. Você pode usar a AWS CLI `describe-db-cluster-parameters` operação Console de gerenciamento da AWS ou a para verificar se o grupo de parâmetros do cluster foi modificado. Para obter mais informações, consulte [Descrevendo grupos de parâmetros de cluster](cluster_parameter_groups-describe.md).

------
#### [ Using the Console de gerenciamento da AWS ]

Siga estas etapas para modificar um grupo de parâmetros do Amazon DocumentDB personalizado. Não é possível modificar um grupo de parâmetros `default`. Se você deseja modificar um valor no grupo de parâmetros `default`, você pode [copiar o grupo de parâmetros de cluster padrão](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-copy.html), modificá-lo e aplicá-lo ao cluster. Para obter mais informações sobre como aplicar grupos de parâmetros ao cluster, consulte [Modificar um cluster do Amazon DocumentDB](db-cluster-modify.md).

**Para modificar um grupos de parâmetros de cluster personalizado**

1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)

1. No painel de navegação, no lado esquerdo do console, selecione **Grupos de parâmetros**. Na lista de grupos de parâmetro, escolha o nome do grupo de parâmetro que deseja modificar.
**dica**  
Caso não visualize o painel de navegação à esquerda da tela, selecione o ícone do menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-menu-icon.png)) no canto superior esquerdo da página.

1. Para cada parâmetro no grupo de parâmetro que desejar modificar, faça o seguinte:

   1. Localize o parâmetro que deseja modificar e verifique se ele é modificável e se está listado como `true` na coluna **Modificável**.

   1. Se for modificável, selecione o parâmetro e escolha **Editar** no canto superior direito da página do console.

   1. Na caixa de diálogo **Modificar `<parameter-name>`**, faça as alterações que deseja. Depois disso, escolha **Modificar parâmetro de cluster** ou **Cancelar** para descartar as alterações.

------
#### [ Using the AWS CLI ]

É possível modificar o `ParameterValue`, a `Description` ou o `ApplyMethod` de qualquer parâmetro modificável em um grupo de parâmetros de cluster personalizado do Amazon DocumentDB usando a AWS CLI. Não é possível fazer modificações diretamente em um grupo de parâmetros de cluster.

Para modificar os parâmetros de um grupo de parâmetros de cluster personalizado, 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. Os parâmetros que você está modificando. Para obter uma lista dos parâmetros que se aplicam a todas as instâncias em um cluster do Amazon DocumentDB, consulte [Referência de parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups-list_of_parameters.md). 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`.

**Example - Modificando o valor de um parâmetro**  
Neste exemplo, você lista os valores de parâmetro de `sample-parameter-group` e modifica o parâmetro `tls`. Em seguida, após esperar 5 minutos, você listará novamente os valores dos parâmetros do `sample-parameter-group` para vê-los alterados.  

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"
              }
          ]
   }
   ```

1. 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"
      }
   ```

1. Aguarde pelo menos 5 minutos.

1. Liste os valores de parâmetros de `sample-parameter-group` para verificar se o parâmetro `tls` foi modificado.

   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": [
              {
                  "ParameterValue": "false",
                  "ParameterName": "enable_audit_logs",
                  "ApplyType": "dynamic",
                  "DataType": "string",
                  "Description": "Enables auditing on cluster.",
                  "AllowedValues": "true,false",
                  "Source": "system",
                  "IsModifiable": true,
                  "ApplyMethod": "pending-reboot"
              },
              {
                  "ParameterValue": "disabled",
                  "ParameterName": "tls",
                  "ApplyType": "static",
                  "DataType": "string",
                  "Description": "Config to enable/disable TLS",
                  "AllowedValues": "disabled,enabled",
                  "Source": "system",
                  "IsModifiable": true,
                  "ApplyMethod": "pending-reboot"
              }
          ]
   }
   ```

------

# Modificando clusters do Amazon DocumentDB para usar grupos de parâmetros de cluster personalizados
<a name="cluster_parameter_groups-modify_clusters"></a>

Ao criar um cluster do Amazon DocumentDB, um grupo de parâmetros `default.docdb4.0` é criado automaticamente para esse cluster. Não é possível modificar o grupo de parâmetros de cluster `default`. Em vez disso, é possível modificar seu cluster do Amazon DocumentDB para associar um novo grupo de parâmetros personalizado a ele. 

Esta seção explica como modificar um cluster Amazon DocumentDB existente para usar um grupo de parâmetros de cluster personalizado usando o Console de gerenciamento da AWS e o AWS Command Line Interface ()AWS CLI. 

------
#### [ Using the Console de gerenciamento da AWS ]

**Como modificar um cluster do Amazon DocumentDB para usar um novo grupo de parâmetros de cluster não padrão**

1. Antes de começar, lembre-se de criar um cluster do Amazon DocumentDB e um grupo de parâmetros de cluster. Consulte [Criar um cluster do Amazon DocumentDB](db-cluster-create.md) e [Criando grupos de parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups-create.md) para obter mais instruções.

1. Depois de criar o grupo de parâmetros de cluster, abra o console do Amazon DocumentDB em [https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb). No painel de navegação, escolha **Clusters** para adicionar o novo grupo de parâmetros a um cluster.

1. Escolha o cluster que deseja associar ao seu grupo de parâmetros. Escolha **Ações** e **Modificar** para modificar seu cluster.

1. Em **Opções de cluster**, escolha o novo grupo de parâmetros ao qual deseja associar o cluster.

1. Escolha **Continuar** para exibir um resumo das modificações.

1. Depois de verificar suas alterações, é possível aplicá-las imediatamente, ou durante a próxima janela de manutenção em **Programação de modificações**.

1. Escolha **Modificar cluster** para atualizar seu cluster com o novo grupo de parâmetros.

------
#### [ Using the AWS CLI ]

Antes de começar, lembre-se de criar um cluster do Amazon DocumentDB e um grupo de parâmetros de cluster. Você pode [criar um cluster Amazon DocumentDB](https://docs.aws.amazon.com//documentdb/latest/developerguide/db-cluster-create.html) usando a AWS CLI `create-db-cluster` operação. Você pode [criar um grupo de parâmetros de cluster](https://docs.aws.amazon.com//documentdb/latest/developerguide/cluster_parameter_groups-create.html) usando a AWS CLI `create-db-cluster-parameter-group` operação.

Para adicionar seu novo grupo de parâmetros de cluster ao seu cluster, use a AWS CLI `modify-db-cluster` operação com os parâmetros a seguir.
+ **-- db-cluster-identifier** — O nome do seu cluster (por exemplo,`sample-cluster`).
+ **-- db-cluster-parameter-group -name** — O nome do grupo de parâmetros ao qual você deseja associar seu cluster (por exemplo,`sample-parameter-group`).

**Example**  

```
aws docdb modify-db-cluster \
    --db-cluster-identifier sample-cluster \
    --db-cluster-parameter-group-name sample-parameter-group
```
A saída dessa operação é semelhante ao seguinte (formato JSON).  

```
"DBCluster": {
    "AvailabilityZones": [
            "us-west-2c",
            "us-west-2b",
            "us-west-2a"
    ],
    "BackupRetentionPeriod": 1,
    "DBClusterIdentifier": "sample-cluster",
    "DBClusterParameterGroup": "sample-parameter-group",
    "DBSubnetGroup": "default",
   ...
}
```

------

# Copiando grupos de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-copy"></a>

Você pode fazer uma cópia de um grupo de parâmetros de cluster no Amazon DocumentDB usando o Console de gerenciamento da AWS ou o AWS Command Line Interface ()AWS CLI.

------
#### [ Using the Console de gerenciamento da AWS ]

O procedimento a seguir orienta durante a criação de um novo grupo de parâmetros de cluster fazendo uma cópia de um grupo de parâmetros de cluster existente.

**Como copiar um grupo de parâmetros de cluster**

1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)

1. No painel de navegação, selecione **Grupos de parâmetros**.

1. No painel **Grupos de parâmetros de cluster**, escolha o nome do grupo de parâmetros de cluster que deseja copiar.

1. Escolha **Ações** e **Copiar** para copiar esse grupo de parâmetros.

1. Em **Opções de cópia**, insira um nome e uma descrição para o novo grupo de parâmetros de cluster. Depois disso, escolha **Copiar** para salvar as alterações.

------
#### [ Using the AWS CLI ]

Para fazer uma cópia de um grupo de parâmetro de cluster, use a operação `copy-db-cluster-parameter-group` com os parâmetros a seguir.
+ **--source-db-cluster-parameter-group-identifier** — Obrigatório. O nome ou nome do recurso da Amazon (ARN) do grupo de parâmetro de cluster cuja cópia você deseja fazer.

  Se os grupos de parâmetros do cluster de origem e de destino estiverem no mesmo Região da AWS, o identificador poderá ser um nome ou um ARN.

  Se os grupos de parâmetros do cluster de origem e de destino estiverem em diferentes Regiões da AWS, o identificador deverá ser um ARN.
+ **--target-db-cluster-parameter-group-identifier** — Obrigatório. O nome ou ARN da cópia do grupo de parâmetro do cluster.

  Restrições:
  + Não pode ser nulo, vazio ou estar em branco.
  + Deve conter de 1 a 255 letras, números ou hifens.
  + O primeiro caractere deve ser uma letra.
  + Não pode terminar com um hífen ou conter dois hifens consecutivos.
+ **--target-db-cluster-parameter-group-description** — Obrigatório. Uma descrição fornecida pelo usuário para a cópia do grupo de parâmetro de cluster.

**Example**  
O código a seguir faz uma cópia de `sample-parameter-group`, nomeando a cópia `sample-parameter-group-copy`.  
Para Linux, macOS ou Unix:  

```
aws docdb copy-db-cluster-parameter-group \
    --source-db-cluster-parameter-group-identifier sample-parameter-group \
    --target-db-cluster-parameter-group-identifier sample-parameter-group-copy \
    --target-db-cluster-parameter-group-description "Copy of sample-parameter-group"
```
Para Windows:  

```
aws docdb copy-db-cluster-parameter-group ^
    --source-db-cluster-parameter-group-identifier sample-parameter-group ^
    --target-db-cluster-parameter-group-identifier sample-parameter-group-copy ^
    --target-db-cluster-parameter-group-description "Copy of sample-parameter-group"
```
A saída dessa operação é semelhante ao seguinte (formato JSON).  

```
{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:sample-parameter-group-copy",
        "DBClusterParameterGroupName": "sample-parameter-group-copy",
        "DBParameterGroupFamily": "docdb4.0",
        "Description": "Copy of sample-parameter-group"
    }
}
```

------

# Redefinindo grupos de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-reset"></a>

Você pode redefinir alguns ou todos os valores de parâmetros de um grupo de parâmetros do cluster Amazon DocumentDB para seus valores padrão usando o Console de gerenciamento da AWS ou o AWS Command Line Interface (AWS CLI) para redefinir o grupo de parâmetros do cluster.

------
#### [ Using the Console de gerenciamento da AWS ]

Siga estas etapas para redefinir alguns ou todos os valores de parâmetros de um grupo de parâmetros de cluster para seus valores padrão.

**Como redefinir os valores de parâmetros de um grupo de parâmetros de cluster**

1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)

1. No painel de navegação, no lado esquerdo do console, selecione **Grupos de parâmetros**.

1. No painel **Grupos de parâmetros de cluster**, escolha o nome do grupo de parâmetros de cluster que deseja redefinir.

1. Escolha **Ações** e **Redefinir** para redefinir esse grupo de parâmetros.

1. Na página **Confirmação de redefinição do grupo de parâmetros de cluster** resultante, confirme se você deseja redefinir todos os parâmetros de cluster para esse grupo de parâmetros para seus padrões. Depois disso, escolha **Redefinir** para redefinir o grupo de parâmetros. Também é possível escolher **Cancelar** para cancelar as alterações.

------
#### [ Using the AWS CLI ]

Para redefinir alguns ou todos os valores de parâmetro do grupos de parâmetros de cluster para seus valores padrão, use a operação `reset-db-cluster-parameter-group` com os parâmetros a seguir.
+ **--db-cluster-parameter-group-name** — Obrigatório. O nome do grupo de parâmetro de cluster a ser redefinido.
+ **--parameters** — Opcional. Uma lista de `ParameterName` e `ApplyMethod` no grupo de parâmetro de cluster para redefinir para seus valores padrão. Os parâmetros estáticos devem ser definidos como `pending-reboot` para entrar em vigor na próxima reinicialização da instância ou na solicitação `reboot-db-instance`. É necessário chamar `reboot-db-instance` para cada instância no cluster cujo parâmetro estático atualizado desejar aplicar.

  Esse parâmetro e `--reset-all-parameters` são mutuamente exclusivos: você pode usar um, mas não ambos.
+ **--reset-all-parameters** ou **--no-reset-all-parameters** — opcional. Especifica se é necessário redefinir todos os parâmetros (`--reset-all-parameters`) ou apenas alguns dos parâmetros (`--no-reset-all-parameters`) para seus valores padrão. O parâmetro `--reset-all-parameters` e `--parameters` são mutuamente exclusivos: você pode usar um, mas não ambos.

  Quando você redefinir o grupo inteiro, os parâmetros dinâmicos serão atualizados imediatamente. Os parâmetros estáticos são definidos como `pending-reboot` para entrarem em vigor na próxima reinicialização da instância, ou na solicitação `reboot-db-instance`. É necessário chamar `reboot-db-instance` para cada instância no cluster na qual deseja que o parâmetro estático atualizado seja aplicado.

**Example**  
**Exemplo 1: redefinindo todos os parâmetros para seus valores padrão**  
O código a seguir redefine todos os parâmetros no grupos de parâmetros de cluster `sample-parameter-group` para seus valores padrão.
Para Linux, macOS ou Unix:  

```
aws docdb reset-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group \
       --reset-all-parameters
```
Para Windows:  

```
aws docdb reset-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group ^
       --reset-all-parameters
```
**Exemplo 2: redefinindo os parâmetros especificados para seus valores padrão**  
O código a seguir redefine o parâmetro `tls` no grupo de parâmetro de cluster `sample-parameter-group` para seu valor padrão.
Para Linux, macOS ou Unix:  

```
aws docdb reset-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group \
       --no-reset-all-parameters \
       --parameters ParameterName=tls,ApplyMethod=pending-reboot
```
Para Windows:  

```
aws docdb reset-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group ^
       --no-reset-all-parameters ^
       --parameters ParameterName=tls,ApplyMethod=pending-reboot
```
A saída dessa operação é semelhante ao seguinte (formato JSON).  

```
{
       "DBClusterParameterGroupName": "sample-parameter-group"
   }
```
**Reiniciando uma instância de cluster**  
Antes que o valor de um parâmetro estático seja alterado, a instância do cluster deve ser reiniciada. Reinicie cada instância no cluster a qual deseje que o parâmetro estático atualizado seja aplicado.
Para Linux, macOS ou Unix:  

```
aws docdb reboot-db-instance \
       --db-instance-identifier sample-cluster-instance
```
Para Windows:  

```
aws docdb reboot-db-instance ^
       --db-instance-identifier sample-cluster-instance
```

------

# Excluindo grupos de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-delete"></a>

Você pode excluir um grupo de parâmetros de cluster personalizado do Amazon DocumentDB usando o Console de gerenciamento da AWS ou o AWS Command Line Interface ()AWS CLI. Não é possível excluir o grupo de parâmetros de cluster `default.docdb4.0`.

------
#### [ Using the Console de gerenciamento da AWS ]

**Para excluir um grupo de parâmetros de cluster**

1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-menu-icon.png)) no canto superior esquerdo da página.

1. No painel **Grupos de parâmetro**, escolha o botão de opção à esquerda do grupos de parâmetros de cluster que deseje excluir.

1. Escolha **Ações** e, em seguida, **Excluir**.

1. No painel de confirmação **Excluir**, escolha **Excluir** para excluir o grupo de parâmetros de cluster. Para manter o grupo de parâmetros de cluster, escolha **Cancelar**.

------
#### [ Using the AWS CLI ]

Para excluir um grupo de parâmetros de cluster, use a operação `delete-db-cluster-parameter-group` com o parâmetro a seguir.
+ **--db-cluster-parameter-group-name** — Obrigatório. O nome do grupo de parâmetro de cluster a ser excluído. Ele deve ser um grupo de parâmetro de cluster existente. *Não é possível excluir o grupo de parâmetros de cluster `default.docdb4.0`. *

**Example - Excluindo um grupo de parâmetros de cluster**  
O exemplo a seguir mostra as três etapas para excluir um grupo de parâmetros de cluster:  

1. Descobrindo o nome do grupos de parâmetros de cluster que deseja excluir.

1. Excluindo o grupo de parâmetros de cluster especificado.

1. Verificando se o grupos de parâmetros de cluster foi excluído.
**1. Localize o nome do grupos de parâmetros de cluster que deseja excluir.**  
A lista de códigos a seguir elenca os nomes de todos os grupos de parâmetro de cluster.
Para Linux, macOS ou Unix:  

```
aws docdb describe-db-cluster-parameter-groups \
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
Para Windows:  

```
aws docdb describe-db-cluster-parameter-groups ^
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
A saída da operação anterior é uma lista dos nomes dos grupos de parâmetros de cluster semelhantes à seguinte (formato JSON).  

```
[
       [
           "default.docdb4.0"
       ],
       [
           "sample-parameter-group"
       ],
       [
           "sample-parameter-group-copy"
       ]
   ]
```
**2. Exclua um grupos de parâmetros de cluster específico.**  
O código a seguir exclui o grupos de parâmetros de cluster `sample-parameter-group-copy`.
Para Linux, macOS ou Unix:  

```
aws docdb delete-db-cluster-parameter-group \
       --db-cluster-parameter-group-name sample-parameter-group-copy
```
Para Windows:  

```
aws docdb delete-db-cluster-parameter-group ^
       --db-cluster-parameter-group-name sample-parameter-group-copy
```
Não há saída dessa operação.  
**3. Verifique se o grupo de parâmetros de cluster especificado foi excluído.**  
O código a seguir lista os nomes de todos os grupos de parâmetro de cluster restantes.
Para Linux, macOS ou Unix:  

```
aws docdb describe-db-cluster-parameter-groups \
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
Para Windows:  

```
aws docdb describe-db-cluster-parameter-groups ^
       --query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName]'
```
A saída da operação anterior é uma lista dos grupos de parâmetro de cluster semelhantes ao seguinte (formato JSON). O grupo de parâmetros de cluster que você acabou de excluir não deve estar na lista.  
A saída dessa operação é semelhante ao seguinte (formato JSON).  

```
[
       [
           "default.docdb4.0"
       ],
       [
           "sample-parameter-group"
       ]
   ]
```

------

# Referência de parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-list_of_parameters"></a>

Quando você altera um parâmetro dinâmico e salva o grupo de parâmetro do cluster, a alteração é aplicada imediatamente, independente da configuração *Aplicar imediatamente*. Quando você altera um parâmetro estático e salva o grupo de parâmetro do cluster, a alteração do parâmetro entra em vigor depois que você reinicia manualmente a instância do cluster. É possível reiniciar uma instância usando o console do Amazon DocumentDB, ou chamando explicitamente `reboot-db-instance`.

A tabela a seguir mostra os parâmetros que se aplicam a todas as instâncias em um cluster do Amazon DocumentDB. 


**Parâmetros no nível do cluster do Amazon DocumentDB**  

| Parâmetro | Valor padrão  | Valores válidos | Modificável | Aplicar tipo | Tipo de dado | Description | 
| --- | --- | --- | --- | --- | --- | --- | 
| audit\$1logs | desabilitado | ativado, desativado, ddl, dml\$1read, dml\$1write, todos, nenhum | Sim | Dinâmico | String | Define se os registros CloudWatch de auditoria da Amazon estão habilitados. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| change\$1stream\$1log\$1retention\$1duration | 10800 | 3600-604800 | Sim | Dinâmico | Inteiro | Define a duração do tempo (em segundos) na qual o log do fluxo de alteração é retido e pode ser consumido.  | 
| default\$1collection\$1compression | desabilitado | ativado, desativado (Amazon DocumentDB 5.0)/zstd, lz4, nenhum (Amazon Document 4.0) DB8 | Sim | Dinâmico | String | Define a configuração de compactação padrão para novas coleções em um cluster [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| profiler | desabilitado | habilitado, desabilitado | Sim | Dinâmico | String | Habilita a criação do perfil para operações lentas. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| profiler\$1sampling\$1rate | 1,0 | 0.0-1.0 | Sim | Dinâmico | Float | Define a taxa de amostragem de operações registradas. | 
| profiler\$1threshold\$1ms | 100 | 50-2147483646 | Sim | Dinâmico | Inteiro | Define o limite para profiler. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| planner\$1version | 3.0 | 1,0, 2,0, 3,0 | Sim | Dinâmico | Float | Define a versão do planejador de consultas a ser usada para consultas.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| tls | habilitado | habilitado, desabilitado, fips-140-3, tls1.2\$1, tls1.3\$1 | Sim | Estático | String | Define se as conexões Transport Layer Security (TLS) são necessárias. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 
| ttl\$1monitor | habilitado | habilitado, desabilitado | Sim | Dinâmico | String | Define se o monitoramento Time to Live (TTL) está habilitado para o cluster. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/cluster_parameter_groups-list_of_parameters.html) | 

# Modificando os parâmetros de cluster do Amazon DocumentDB
<a name="cluster_parameter_groups-parameters"></a>

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
<a name="cluster_parameter_groups-describe_details_parameters"></a>

Você pode ver os parâmetros de um cluster Amazon DocumentDB e seus valores usando o Console de gerenciamento da AWS ou. AWS CLI

------
#### [ Using the Console de gerenciamento da AWS ]

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

1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-menu-icon.png)) no canto superior esquerdo da página.

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

1. 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.  
![\[Captura de tela: nomes e valores de parâmetros.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-determine-parameter-value.png)

------
#### [ 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`.

**Example**  
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
<a name="cluster_parameter_groups-modify_parameters"></a>

Você pode modificar os parâmetros de um grupo de parâmetros usando o Console de gerenciamento da AWS ou AWS CLI.

------
#### [ Using the Console de gerenciamento da AWS ]

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

1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)

1. 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 (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-menu-icon.png)) no canto superior esquerdo da página.

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

1. 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.

1. 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](cluster_parameter_groups-list_of_parameters.md).

1. 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"
           }
       ]
   }
   ```

1. **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"
   }
   ```

1. **Aguarde pelo menos 5 minutos.**

1. **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"
           }
       ]
   }
   ```

------