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á.
# Referência de parâmetros de cluster do Amazon DocumentDB
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
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 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
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"
}
]
}
```
------