Container for the parameters to the ModifyDBInstance operation.
Namespace: Amazon.RDS.ModelModify 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.
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)
Syntax
| C# | Visual Basic | Visual C++ |
public class ModifyDBInstanceRequest : AmazonWebServiceRequest
Public Class ModifyDBInstanceRequest _ Inherits AmazonWebServiceRequest
public ref class ModifyDBInstanceRequest : public AmazonWebServiceRequest
Members
| All Members | Constructors | Properties | Methods |
| Member | Description | |||
|---|---|---|---|---|
| ModifyDBInstanceRequest()()()() | Initializes a new instance of the ModifyDBInstanceRequest class | |||
| AllocatedStorage |
The new storage capacity of the RDS instance. This change does not result in an outage and is applied during the next maintenance window
unless the ApplyImmediately parameter is specified as 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 MySQL 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.
| |||
| AllowMajorVersionUpgrade |
Indicates that major version upgrades are allowed. 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. Default: false | |||
| AutoMinorVersionUpgrade |
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.
| |||
| 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. Default: Uses existing setting Constraints:
| |||
| DBInstanceClass |
The new compute and memory capacity of the DB Instance. 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.m1.small | 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. This change is asynchronously applied as soon as possible for parameters
when the ApplyImmediately parameter is specified as 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. This change is asynchronously applied as soon as possible. Constraints:
| |||
| EngineVersion |
The version number of the database engine to upgrade to. For major version upgrades, if a nondefault 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.) | |||
| MasterUserPassword |
The new password for the DB Instance master user. This 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 4 to 41 alphanumeric characters (engine specific)
| |||
| MultiAZ |
Specifies if the DB Instance is a Multi-AZ deployment. Constraints: Cannot be specified if the DB Instance is a read replica.
| |||
| PreferredBackupWindow |
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod. Constraints:
| |||
| PreferredMaintenanceWindow |
The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. This change is made immediately. If
moving this window to the current time, there must be at least 120 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()()()() | (Inherited from Object.) | |||
| WithAllocatedStorage(Int32) |
Sets the AllocatedStorage property
| |||
| WithAllowMajorVersionUpgrade(Boolean) |
Sets the AllowMajorVersionUpgrade property
| |||
| WithApplyImmediately(Boolean) |
Sets the ApplyImmediately property
| |||
| WithAutoMinorVersionUpgrade(Boolean) |
Sets the AutoMinorVersionUpgrade property
| |||
| WithBackupRetentionPeriod(Int32) |
Sets the BackupRetentionPeriod property
| |||
| WithDBInstanceClass(String) |
Sets the DBInstanceClass property
| |||
| WithDBInstanceIdentifier(String) |
Sets the DBInstanceIdentifier property
| |||
| WithDBParameterGroupName(String) |
Sets the DBParameterGroupName property
| |||
| WithDBSecurityGroups(IEnumerable<(Of <<'(String>)>>)) |
Adds elements to the DBSecurityGroups collection
| |||
| WithDBSecurityGroups(array<String>[]()[][]) |
Adds elements to the DBSecurityGroups collection
| |||
| WithEngineVersion(String) |
Sets the EngineVersion property
| |||
| WithMasterUserPassword(String) |
Sets the MasterUserPassword property
| |||
| WithMultiAZ(Boolean) |
Sets the MultiAZ property
| |||
| WithPreferredBackupWindow(String) |
Sets the PreferredBackupWindow property
| |||
| WithPreferredMaintenanceWindow(String) |
Sets the PreferredMaintenanceWindow property
|
Inheritance Hierarchy
System..::..Object
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.RDS.Model..::..ModifyDBInstanceRequest
Amazon.Runtime..::..AmazonWebServiceRequest
Amazon.RDS.Model..::..ModifyDBInstanceRequest