AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginModifyDBClusterParameterGroup and EndModifyDBClusterParameterGroup.

Namespace: Amazon.DocDB
Assembly: AWSSDK.DocDB.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<ModifyDBClusterParameterGroupResponse> ModifyDBClusterParameterGroupAsync(
         ModifyDBClusterParameterGroupRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.DocDB.Model.ModifyDBClusterParameterGroupRequest

Container for the necessary parameters to execute the ModifyDBClusterParameterGroup service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ModifyDBClusterParameterGroup service method, as returned by DocDB.

Exceptions

ExceptionCondition
DBParameterGroupNotFoundException DBParameterGroupName doesn't refer to an existing parameter group.
InvalidDBParameterGroupStateException The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also