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.
Namespace: Amazon.RDS.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class ModifyDBInstanceRequest : AmazonRDSRequest IRequestEvents
The ModifyDBInstanceRequest type exposes the following members
Name | Description | |
---|---|---|
ModifyDBInstanceRequest() | Empty constructor used to set properties independently even when a simple constructor is available | |
ModifyDBInstanceRequest(string) | Instantiates ModifyDBInstanceRequest with the parameterized properties |
Name | Type | Description | |
---|---|---|---|
AllocatedStorage | System.Int32 |
Gets and sets the property AllocatedStorage.
The new storage capacity of the RDS instance. Changing this setting does not result
in an outage and the change is applied during the next maintenance window unless MySQL Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer MariaDB Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer PostgreSQL Default: Uses existing setting Valid Values: 5-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. Type: Integer Oracle Default: Uses existing setting Valid Values: 10-6144 Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. SQL Server Cannot be modified. If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. |
|
AllowMajorVersionUpgrade | System.Boolean |
Gets and sets the property AllowMajorVersionUpgrade.
Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. |
|
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
If this parameter is set to
Default: |
|
AutoMinorVersionUpgrade | System.Boolean |
Gets and sets the property AutoMinorVersionUpgrade.
Indicates that minor version upgrades will be applied automatically to the DB instance
during the maintenance window. Changing this parameter does not 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 |
|
BackupRetentionPeriod | System.Int32 |
Gets and sets the property BackupRetentionPeriod.
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Changing this parameter can result in an outage if you change from 0 to a non-zero
value or from a non-zero value to 0. These changes are applied during the next maintenance
window unless the Default: Uses existing setting Constraints:
|
|
CACertificateIdentifier | System.String |
Gets and sets the property CACertificateIdentifier.
Indicates the certificate that needs to be associated with the instance. |
|
CopyTagsToSnapshot | System.Boolean |
Gets and sets the property CopyTagsToSnapshot.
True to copy all tags from the DB instance to snapshots of the DB instance; 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. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.
Passing a value for this setting causes an outage during the change and is applied
during the next maintenance window, unless Default: Uses existing setting Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large |
|
DBInstanceIdentifier | System.String |
Gets and sets the property DBInstanceIdentifier.
The DB instance identifier. This value is stored as a lowercase string. Constraints:
|
|
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 does not 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
Your database will restart when you change the MySQL
Default:
Valid Values: MariaDB
Default:
Valid Values: PostgreSQL
Default:
Valid Values: Oracle
Default:
Valid Values: SQL Server
Default:
Valid Values: Amazon Aurora
Default:
Valid Values: |
|
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 does not result in an outage and the change is asynchronously applied as soon as possible. Constraints:
|
|
EngineVersion | System.String |
Gets and sets the property EngineVersion.
The version number of the database engine to upgrade to. Changing this parameter
results in an outage and the change is applied during the next maintenance window
unless the For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. For a list of valid engine versions, see CreateDBInstance. |
|
Iops | System.Int32 |
Gets and sets the property Iops.
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting does not result in an outage and the change is applied during
the next maintenance window unless the Default: Uses existing setting Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect. SQL Server Setting the IOPS value for the SQL Server database engine is not supported. Type: Integer If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance. |
|
MasterUserPassword | System.String |
Gets and sets the property MasterUserPassword.
The new password for the DB instance master user. Can be any printable ASCII character except "/", """, or "@".
Changing this parameter does not result in an outage and the change is asynchronously
applied as soon as possible. Between the time of the request and the completion of
the request, the Default: Uses existing setting Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server). |
|
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 60.
If
Valid Values: |
|
MonitoringRoleArn | System.String |
Gets and sets the property MonitoringRoleArn.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch
Logs. For example,
If |
|
MultiAZ | System.Boolean |
Gets and sets the property MultiAZ.
Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does
not result in an outage and the change is applied during the next maintenance window
unless the Constraints: Cannot be specified if the DB instance is a Read Replica. This parameter cannot be used with SQL Server DB instances. Multi-AZ for SQL Server DB instances is set using the Mirroring option in an option group associated with the DB instance. |
|
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 Constraints:
|
|
OptionGroupName | System.String |
Gets and sets the property OptionGroupName.
Indicates that the DB instance should be associated with the specified option group.
Changing this parameter does not result in an outage except in the following case
and the change is applied during the next maintenance window unless the Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance |
|
PreferredBackupWindow | System.String |
Gets and sets the property PreferredBackupWindow.
The daily time range during which automated backups are created if automated backups
are enabled, as determined by the Constraints:
|
|
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 does not 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 |
|
PubliclyAccessible | System.Boolean |
Gets and sets the property PubliclyAccessible.
True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. False to make the DB instance internal with a DNS name that resolves to a private IP address.
Changes to the Default: false |
|
StorageType | System.String |
Gets and sets the property StorageType.
Specifies the storage type to be associated with the DB instance.
Valid values:
If you specify
Default: |
|
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. Constraints:
|
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1