ModifyDBInstanceRequest Class | AWS SDK for .NET V3

Container for the parameters to the ModifyDBInstance operation. Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

Inheritance Hierarchy

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

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

Syntax

public class ModifyDBInstanceRequest : AmazonNeptuneRequest
         IAmazonWebServiceRequest

The ModifyDBInstanceRequest type exposes the following members

Constructors

	Name	Description
	ModifyDBInstanceRequest()

Properties

Name	Type	Description
AllocatedStorage	System.Int32	Gets and sets the property AllocatedStorage. Not supported by Neptune.
AllowMajorVersionUpgrade	System.Boolean	Gets and sets the property AllowMajorVersionUpgrade. Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
ApplyImmediately	System.Boolean	Gets and sets the property ApplyImmediately. 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 instance. If this parameter is set to `false`, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Default: `false`
AutoMinorVersionUpgrade	System.Boolean	Gets and sets the property AutoMinorVersionUpgrade. Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to `true` during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.
BackupRetentionPeriod	System.Int32	Gets and sets the property BackupRetentionPeriod. Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting
CACertificateIdentifier	System.String	Gets and sets the property CACertificateIdentifier. Indicates the certificate that needs to be associated with the instance.
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 instance or DB cluster.
CopyTagsToSnapshot	System.Boolean	Gets and sets the property CopyTagsToSnapshot. True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.
DBInstanceClass	System.String	Gets and sets the property DBInstanceClass. The new compute and memory capacity of the DB instance, for example, `db.m4.large`. Not all DB instance classes are available in all Amazon Regions. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless `ApplyImmediately` is specified as `true` for this request. Default: Uses existing setting
DBInstanceIdentifier	System.String	Gets and sets the property DBInstanceIdentifier. The DB instance identifier. This value is stored as a lowercase string. Constraints: Must match the identifier of an existing DBInstance.
DBParameterGroupName	System.String	Gets and sets the property DBParameterGroupName. The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
DBPortNumber	System.Int32	Gets and sets the property DBPortNumber. The port number on which the database accepts connections. The value of the `DBPortNumber` parameter must not match any of the port values specified for options in the option group for the DB instance. Your database will restart when you change the `DBPortNumber` value regardless of the value of the `ApplyImmediately` parameter. Default: `8182`
DBSecurityGroups	System.Collections.Generic.List<System.String>	Gets and sets the property DBSecurityGroups. A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: If supplied, must match existing DBSecurityGroups.
DBSubnetGroupName	System.String	Gets and sets the property DBSubnetGroupName. The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify `true` for the `ApplyImmediately` parameter. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: `mySubnetGroup`
DeletionProtection	System.Boolean	Gets and sets the property DeletionProtection. A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.
Domain	System.String	Gets and sets the property Domain. Not supported.
DomainIAMRoleName	System.String	Gets and sets the property DomainIAMRoleName. Not supported
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. You can enable IAM database authentication for the following database engines Not applicable. Mapping Amazon IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster. Default: `false`
EnablePerformanceInsights	System.Boolean	Gets and sets the property EnablePerformanceInsights. (Not supported by Neptune)
EngineVersion	System.String	Gets and sets the property EngineVersion. The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.
Iops	System.Int32	Gets and sets the property Iops. The new Provisioned IOPS (I/O operations per second) value for the instance. Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the `ApplyImmediately` parameter is set to `true` for this request. Default: Uses existing setting
LicenseModel	System.String	Gets and sets the property LicenseModel. Not supported by Neptune.
MasterUserPassword	System.String	Gets and sets the property MasterUserPassword. Not supported by Neptune.
MonitoringInterval	System.Int32	Gets and sets the property MonitoringInterval. The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If `MonitoringRoleArn` is specified, then you must also set `MonitoringInterval` to a value other than 0. Valid Values: `0, 1, 5, 10, 15, 30, 60`
MonitoringRoleArn	System.String	Gets and sets the property MonitoringRoleArn. The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, `arn:aws:iam:123456789012:role/emaccess`. If `MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value.
MultiAZ	System.Boolean	Gets and sets the property MultiAZ. Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the `ApplyImmediately` parameter is set to `true` for this request.
NewDBInstanceIdentifier	System.String	Gets and sets the property NewDBInstanceIdentifier. The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set `Apply Immediately` to true, or will occur during the next maintenance window if `Apply Immediately` to false. 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: `mydbinstance`
OptionGroupName	System.String	Gets and sets the property OptionGroupName. (Not supported by Neptune)
PerformanceInsightsKMSKeyId	System.String	Gets and sets the property PerformanceInsightsKMSKeyId. (Not supported by Neptune)
PreferredBackupWindow	System.String	Gets and sets the property PreferredBackupWindow. The daily time range during which automated backups are created if automated backups are enabled. Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: Must be in the format hh24:mi-hh24:mi Must be in Universal Time Coordinated (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 (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied. Default: Uses existing setting Format: ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun Constraints: Must be at least 30 minutes
PromotionTier	System.Int32	Gets and sets the property PromotionTier. A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance. Default: 1 Valid Values: 0 - 15
PubliclyAccessible	System.Boolean	Gets and sets the property PubliclyAccessible. Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
StorageType	System.String	Gets and sets the property StorageType. Not applicable. In Neptune the storage type is managed at the DB Cluster level.
TdeCredentialArn	System.String	Gets and sets the property TdeCredentialArn. The ARN from the key store with which to associate the instance for TDE encryption.
TdeCredentialPassword	System.String	Gets and sets the property TdeCredentialPassword. The password for the given ARN from the key store in order to access the device.
VpcSecurityGroupIds	System.Collections.Generic.List<System.String>	Gets and sets the property VpcSecurityGroupIds. A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: If supplied, must match existing VpcSecurityGroupIds.

Examples

This example immediately changes the specified settings for the specified DB instance.

To change DB instance settings


var response = client.ModifyDBInstance(new ModifyDBInstanceRequest 
{
    AllocatedStorage = 10,
    ApplyImmediately = true,
    BackupRetentionPeriod = 1,
    DBInstanceClass = "db.t2.small",
    DBInstanceIdentifier = "mymysqlinstance",
    MasterUserPassword = "mynewpassword",
    PreferredBackupWindow = "04:00-04:30",
    PreferredMaintenanceWindow = "Tue:05:00-Tue:05:30"
});

DBInstance dbInstance = response.DBInstance;

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, 3.5