ModifyDBClusterRequest Class | AWS SDK for .NET V3

Container for the parameters to the ModifyDBCluster operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptune.AmazonNeptuneRequest
      Amazon.Neptune.Model.ModifyDBClusterRequest

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

Syntax

public class ModifyDBClusterRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest

The ModifyDBClusterRequest type exposes the following members

Constructors

	Name	Description
	ModifyDBClusterRequest()

Properties

Name	Type	Description
AllowMajorVersionUpgrade	System.Boolean	Gets and sets the property AllowMajorVersionUpgrade. A value that indicates whether upgrades between different major versions are allowed. Constraints: You must set the allow-major-version-upgrade flag when providing an `EngineVersion` parameter that uses a different major version than the DB cluster's current version.
ApplyImmediately	System.Boolean	Gets and sets the property ApplyImmediately. A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the `PreferredMaintenanceWindow` setting for the DB cluster. If this parameter is set to `false`, changes to the DB cluster are applied during the next maintenance window. The `ApplyImmediately` parameter only affects `NewDBClusterIdentifier` values. If you set the `ApplyImmediately` parameter value to false, then changes to `NewDBClusterIdentifier` values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the `ApplyImmediately` parameter. Default: `false`
BackupRetentionPeriod	System.Int32	Gets and sets the property BackupRetentionPeriod. The number of days for which automated backups are retained. You must specify a minimum value of 1. Default: 1 Constraints: Must be a value from 1 to 35
CloudwatchLogsExportConfiguration	Amazon.Neptune.Model.CloudwatchLogsExportConfiguration	Gets and sets the property CloudwatchLogsExportConfiguration. The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. See Using the CLI to publish Neptune audit logs to CloudWatch Logs.
CopyTagsToSnapshot	System.Boolean	Gets and sets the property CopyTagsToSnapshot. If set to `true`, tags are copied to any snapshot of the DB cluster that is created.
DBClusterIdentifier	System.String	Gets and sets the property DBClusterIdentifier. The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive. Constraints: Must match the identifier of an existing DBCluster.
DBClusterParameterGroupName	System.String	Gets and sets the property DBClusterParameterGroupName. The name of the DB cluster parameter group to use for the DB cluster.
DBInstanceParameterGroupName	System.String	Gets and sets the property DBInstanceParameterGroupName. The name of the DB parameter group to apply to all instances of the DB cluster. When you apply a parameter group using `DBInstanceParameterGroupName`, parameter changes aren't applied during the next maintenance window but instead are applied immediately. Default: The existing name setting Constraints: The DB parameter group must be in the same DB parameter group family as the target DB cluster version. The `DBInstanceParameterGroupName` parameter is only valid in combination with the `AllowMajorVersionUpgrade` parameter.
DeletionProtection	System.Boolean	Gets and sets the property DeletionProtection. A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
EnableIAMDatabaseAuthentication	System.Boolean	Gets and sets the property EnableIAMDatabaseAuthentication. True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false. Default: `false`
EngineVersion	System.String	Gets and sets the property EngineVersion. The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the `ApplyImmediately` parameter is set to true. For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.
MasterUserPassword	System.String	Gets and sets the property MasterUserPassword. Not supported by Neptune.
NewDBClusterIdentifier	System.String	Gets and sets the property NewDBClusterIdentifier. The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Example: `my-cluster2`
OptionGroupName	System.String	Gets and sets the property OptionGroupName. Not supported by Neptune.
Port	System.Int32	Gets and sets the property Port. The port number on which the DB cluster accepts connections. Constraints: Value must be `1150-65535` Default: The same port as the original DB cluster.
PreferredBackupWindow	System.String	Gets and sets the property PreferredBackupWindow. The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. Constraints: Must be in the format `hh24:mi-hh24:mi`. Must be in Universal Coordinated Time (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
PreferredMaintenanceWindow	System.String	Gets and sets the property PreferredMaintenanceWindow. The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: `ddd:hh24:mi-ddd:hh24:mi` The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window.
ServerlessV2ScalingConfiguration	Amazon.Neptune.Model.ServerlessV2ScalingConfiguration	Gets and sets the property ServerlessV2ScalingConfiguration. Contains the scaling configuration of a Neptune Serverless DB cluster. For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.
StorageType	System.String	Gets and sets the property StorageType. The storage type to associate with the DB cluster. Valid Values: `standard \| iopt1` Default: `standard`
VpcSecurityGroupIds	System.Collections.Generic.List<System.String>	Gets and sets the property VpcSecurityGroupIds. A list of VPC security groups that the DB cluster will belong to.

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 Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5