Amazon DocumentDB Cluster Parameters Reference

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
ParameterDefault ValueValid ValuesModifiableApply TypeData TypeDescription
audit_logsdisabledenabled, disabledYesDynamicStringDefines whether AWS CloudTrail audit logs are enabled.
  • enabled—CloudTrail audit logs are enabled.

  • disabled—CloudTrail audit logs are disabled.

change_stream_log_retention_duration108003600-86400YesDynamicIntegerDefines the duration of time (in seconds) that the change stream log is retained and can be consumed.
profilerdisabledenabled, disabledYesDynamicStringEnables profiling for slow operations.
  • enabled—operations that take longer than a customer-defined threshold value (e.g., 100ms) are logged toAmazon CloudWatch Logs.

  • disabled—slow operations are not logged to CloudWatch Logs.

profiler_sampling_rate1.00.0-1.0YesDynamicFloatDefines the sampling rate for logged operations.
profiler_threshold_ms10050-2147483646YesDynamicIntegerDefines the threshold for profiler.
  • All operations greater than profiler_threshold_ms are logged to CloudWatch Logs.

tlsenabledenabled, disabledYesStaticStringDefines whether Transport Layer Security (TLS) connections are required.
  • enabled—TLS connections are required to connect.

  • disabled—TLS connections cannot be used to connect.

ttl_monitorenabledenabled, disabledYesDynamicStringDefines whether Time to Live (TTL) monitoring is enabled for the cluster.
  • enabled—TTL monitoring is enabled.

  • disabled—TTL monitoring is disabled.