Container for the parameters to the ModifyDBInstance operation.
Modify 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.
Declaration Syntax
C# |
public class ModifyDBInstanceRequest : AmazonWebServiceRequest
Members
All Members | Constructors | Methods | Properties | ||
Icon | Member | Description | ||
---|---|---|---|---|
ModifyDBInstanceRequest()()()() | Initializes a new instance of the ModifyDBInstanceRequest class | |||
AllocatedStorage |
The new storage capacity of the RDS instance. Changing this parameter does not 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. MySQL Default: Uses existing
setting Valid Values: 5-1024 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-1024 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 may 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 |
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 |
Specifies whether or not 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 passed as false, changes to the
DB instance are applied on the next call to RebootDBInstance, the next maintenance reboot, or the next failure reboot, whichever
occurs first. See each parameter to determine when a change is applied. Default: false | |||
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 true during the maintenance window, and a newer minor version is available, and RDS has
enabled auto patching for that engine version.
| |||
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 ApplyImmediately parameter is set to true
for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as
soon as possible. Default: Uses existing setting Constraints:
| |||
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 parameter causes an outage during the change and is applied
during the next maintenance window, unless the ApplyImmediately parameter is specified as true for this request. 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 | |||
DBInstanceIdentifier |
The DB instance identifier. This value is stored as a lowercase string. Constraints:
| |||
DBParameterGroupName |
The name of the DB parameter group to apply to this DB instance. Changing this parameter does not 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 Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
| |||
DBSecurityGroups |
A list of DB security groups to authorize on this DB instance. Changing this parameter does not result in an outage and the change is
asynchronously applied as soon as possible. Constraints:
| |||
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 ApplyImmediately parameter is set to true for this request. 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. Example: 5.1.42 | |||
Equals(Object) | (Inherited from Object.) | |||
GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) | |||
GetType()()()() | Gets the type of the current instance. (Inherited from Object.) | |||
Iops |
The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this parameter does not 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 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 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 may 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 |
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 MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Default:
Uses existing setting Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128
alphanumeric characters (SQL Server).
| |||
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 ApplyImmediately parameter is set to true for this request. Constraints: Cannot be
specified if the DB instance is a read replica.
| |||
NewDBInstanceIdentifier |
The new DB instance identifier for the DB instance when renaming a DB Instance. This value is stored as a lowercase string. Constraints:
| |||
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 ApplyImmediately parameter is
set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief
(sub-second) period during which new connections are rejected but existing connections are not interrupted. 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 |
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as
possible. Constraints:
| |||
PreferredMaintenanceWindow |
The weekly time range (in UTC) during which system maintenance can occur, which may 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
| |||
ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) | |||
VpcSecurityGroupIds |
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Constraints:
| |||
WithAllocatedStorage(Int32) | Obsolete.
Sets the AllocatedStorage property
| |||
WithAllowMajorVersionUpgrade(Boolean) | Obsolete.
Sets the AllowMajorVersionUpgrade property
| |||
WithApplyImmediately(Boolean) | Obsolete.
Sets the ApplyImmediately property
| |||
WithAutoMinorVersionUpgrade(Boolean) | Obsolete.
Sets the AutoMinorVersionUpgrade property
| |||
WithBackupRetentionPeriod(Int32) | Obsolete.
Sets the BackupRetentionPeriod property
| |||
WithDBInstanceClass(String) | Obsolete.
Sets the DBInstanceClass property
| |||
WithDBInstanceIdentifier(String) | Obsolete.
Sets the DBInstanceIdentifier property
| |||
WithDBParameterGroupName(String) | Obsolete.
Sets the DBParameterGroupName property
| |||
WithDBSecurityGroups(array<String>[]()[][]) | Obsolete.
Adds elements to the DBSecurityGroups collection
| |||
WithDBSecurityGroups(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the DBSecurityGroups collection
| |||
WithEngineVersion(String) | Obsolete.
Sets the EngineVersion property
| |||
WithIops(Int32) | Obsolete.
Sets the Iops property
| |||
WithMasterUserPassword(String) | Obsolete.
Sets the MasterUserPassword property
| |||
WithMultiAZ(Boolean) | Obsolete.
Sets the MultiAZ property
| |||
WithNewDBInstanceIdentifier(String) | Obsolete.
Sets the NewDBInstanceIdentifier property
| |||
WithOptionGroupName(String) | Obsolete.
Sets the OptionGroupName property
| |||
WithPreferredBackupWindow(String) | Obsolete.
Sets the PreferredBackupWindow property
| |||
WithPreferredMaintenanceWindow(String) | Obsolete.
Sets the PreferredMaintenanceWindow property
| |||
WithVpcSecurityGroupIds(array<String>[]()[][]) | Obsolete.
Adds elements to the VpcSecurityGroupIds collection
| |||
WithVpcSecurityGroupIds(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the VpcSecurityGroupIds collection
|
Inheritance Hierarchy
Object | ||
AmazonWebServiceRequest | ||
ModifyDBInstanceRequest |