

# Amazon DocumentDB cluster parameters reference
<a name="cluster_parameter_groups-list_of_parameters"></a>

When you change a dynamic parameter and save the cluster parameter group, the change is applied immediately regardless of the *Apply immediately* setting. When you change a static parameter and save the cluster parameter group, the parameter change takes effect after you manually reboot the instance. You can reboot an instance using the Amazon DocumentDB console or by explicitly calling `reboot-db-instance`.

The following table shows the parameters that apply to all instances in an Amazon DocumentDB cluster. 


**Amazon DocumentDB cluster-level parameters**  

| Parameter | Default Value | Valid Values | Modifiable | Apply Type | Data Type | Description | 
| --- | --- | --- | --- | --- | --- | --- | 
| audit\_logs | disabled | enabled, disabled, ddl, dml\_read, dml\_write, all, none | Yes | Dynamic | String | Defines whether Amazon CloudWatch audit logs are enabled. +  **enabled** — CloudWatch audit logs are enabled. <br />+  **disabled** — CloudWatch audit logs are disabled. <br />+  **ddl** — auditing for DDL events is enabled. <br />+  **dml\_read** — auditing for DML read events is enabled. <br />+  **dml\_write** — auditing for DML write events is enabled. <br />+  **all** — auditing for all database events is enabled. <br />+  **none** — auditing is disabled.  | 
| change\_stream\_log\_retention\_duration | 10800 | 3600-604800 | Yes | Dynamic | Integer | Defines the duration of time (in seconds) that the change stream log is retained and can be consumed.  | 
| default\_collection\_compression | disabled | enabled, disabled (Amazon DocumentDB 5.0) / zstd, lz4, none (Amazon DocumentDB8.0) | Yes | Dynamic | String | Defines the default compression setting for new collections in a cluster + **enabled** — Lz4 compression is enabled by default in Amazon DocumentDB 5.0. zstd compression is enabled by default in Amazon DocumentDB 8.0.<br />+ **disabled, none** — compression is disabled by default (disabled in Amazon DocumentDB 5.0, none in Amazon DocumentDB 8.0). | 
| profiler | disabled | enabled, disabled | Yes | Dynamic | String | Enables profiling for slow operations. +  **enabled** — operations that take longer than a customer-defined threshold value (e.g., 100ms) are logged toAmazon CloudWatch Logs. <br />+  **disabled** — slow operations are not logged to CloudWatch Logs.  | 
| profiler\_sampling\_rate | 1.0 | 0.0-1.0 | Yes | Dynamic | Float | Defines the sampling rate for logged operations. | 
| profiler\_threshold\_ms | 100 | 50-2147483646 | Yes | Dynamic | Integer | Defines the threshold for profiler. +  All operations greater than `profiler_threshold_ms` are logged to CloudWatch Logs.  | 
| planner\_version | 3.0 | 1.0, 2.0, 3.0 | Yes | Dynamic | Float | Defines the query planner version to use for queries.+  **1.0** — Supported in Amazon DocumentDB 5.0. <br />+  **2.0** — Improvements to find and update operators. Supported in Amazon DocumentDB 5.0. <br />+  **3.0** — Improvements to find, update and aggregation operators. Default query planner in Amazon DocumentDB 8.0.  | 
| tls | enabled | enabled, disabled, fips-140-3, tls1.2\+, tls1.3\+ | Yes | Static | String | Defines whether Transport Layer Security (TLS) connections are required. +  **enabled** — TLS connections are required to connect. For Amazon DocumentDB 5.0 and earlier, this enables TLS 1.0 through 1.3, but use TLS 1.2 or higher. Only TLS 1.2 and higher is supported on Amazon DocumentDB 5.0 starting with minor version 5.0.1, Amazon DocumentDB 8.0 and newer. <br />+  **disabled** — TLS connections cannot be used to connect. <br />+  **fips-140-3** — TLS connections with Federal Information Processing Standards (FIPS) attributes are required to connect. The cluster only accepts secure connections per FIPS Publication 140-3. This is only supported starting with Amazon DocumentDB 5.0 (engine version 3.0.3727) clusters in these Regions: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1. <br />+  **tls1.2\+** — TLS connections using TLS version 1.2 and above are required to connect. This is only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051). <br />+  **tls1.3\+** — TLS connections using TLS version 1.3 and above are required to connect. This is only supported starting with Amazon DocumentDB 4.0 (engine version 2.0.10980) and Amazon DocumentDB 5.0 (engine version 3.0.11051).  | 
| ttl\_monitor | enabled | enabled, disabled | Yes | Dynamic | String | Defines whether Time to Live (TTL) monitoring is enabled for the cluster. +  **enabled** — TTL monitoring is enabled. <br />+  **disabled** — TTL monitoring is disabled.  | 