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.

Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ModifyDBClusterAsync.

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

Syntax

C#
public abstract ModifyDBClusterResponse ModifyDBCluster(
         ModifyDBClusterRequest request
)

Parameters

request
Type: Amazon.Neptune.Model.ModifyDBClusterRequest

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

Return Value


The response from the ModifyDBCluster service method, as returned by Neptune.

Exceptions

ExceptionCondition
DBClusterAlreadyExistsException User already has a DB cluster with the given identifier.
DBClusterNotFoundException DBClusterIdentifier does not refer to an existing DB cluster.
DBClusterParameterGroupNotFoundException DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.
DBSubnetGroupNotFoundException DBSubnetGroupName does not refer to an existing DB subnet group.
InvalidDBClusterStateException The DB cluster is not in a valid state.
InvalidDBInstanceStateException The specified DB instance is not in the available state.
InvalidDBSecurityGroupStateException The state of the DB security group does not allow deletion.
InvalidDBSubnetGroupStateException The DB subnet group cannot be deleted because it is in use.
InvalidSubnetException The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.
InvalidVPCNetworkStateException DB subnet group does not cover all Availability Zones after it is created because users' change.
StorageQuotaExceededException Request would result in user exceeding the allowed amount of storage available across all DB instances.
StorageTypeNotSupportedException StorageType specified cannot be associated with the DB Instance.

Examples

This example changes the specified settings for the specified DB cluster.

To change DB cluster settings


var response = client.ModifyDBCluster(new ModifyDBClusterRequest 
{
    ApplyImmediately = true,
    DBClusterIdentifier = "mydbcluster",
    MasterUserPassword = "mynewpassword",
    NewDBClusterIdentifier = "mynewdbcluster",
    PreferredBackupWindow = "04:00-04:30",
    PreferredMaintenanceWindow = "Tue:05:00-Tue:05:30"
});

DBCluster dbCluster = response.DBCluster;

            

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also