Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14106236407.5 KB

Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

get/#Action=ModifyDBClusterParameterGroup

Query parameters

DBClusterParameterGroupNamestring required

The name of the cluster parameter group to modify.

ParameterNamestring

Specifies the name of the parameter.

ParameterValuestring

Specifies the value of the parameter.

Descriptionstring

Provides a description of the parameter.

Sourcestring

Indicates the source of the parameter value.

ApplyTypestring

Specifies the engine-specific parameters type.

DataTypestring

Specifies the valid data type for the parameter.

AllowedValuesstring

Specifies the valid range of values for the parameter.

IsModifiableboolean

Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

MinimumEngineVersionstring

The earliest engine version to which the parameter can apply.

ApplyMethod'immediate' | 'pending-reboot'

Indicates when to apply parameter updates.

A list of parameters in the cluster parameter group to modify.

Action'ModifyDBClusterParameterGroup' required
Version'2014-10-31' required

Response

Success