ModifyDBInstance - Amazon Relational Database Service

Description

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.

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name Description Required

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

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.

Type: Integer

No

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.

Type: Boolean

No

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

Type: Boolean

No

AutoMinorVersionUpgrade

Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window.

Type: Boolean

No

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:

Must be a value from 0 to 8
Cannot be set to 0 if the DB Instance is a master instance with read replicas or of the DB Instance is a read replica

Type: Integer

No

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

Type: String

No

DBInstanceIdentifier

The DB Instance identifier. This value is stored as a lowercase string. For a SQL Server DB Instance, this value cannot be changed.

Constraints:

Must be the identifier for an existing DB Instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Example:

Type: String

Yes

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.

Type: String

No

DBSecurityGroups.member.N

A list of DB Security Groups to authorize on this DB Instance. This change is asynchronously applied as soon as possible.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Type: String list

No

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

Type: String

No

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 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

	Note
	Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost.

Type: String

No

MultiAZ

Specifies if the DB Instance is a Multi-AZ deployment.

Constraints: Cannot be specified if the DB Instance is a read replica.

Type: Boolean

No

OptionGroupName

Indicates that the DB Instance should be associated with the specified option group.

Type: String

No

PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Constraints:

Must be in the format hh24:mi-hh24:mi
Times should be Universal Time Coordinated (UTC)
Must not conflict with the preferred maintenance window
Must be at least 30 minutes

Type: String

No

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

Type: String

No

Response Elements

The following elements come wrapped in a DBInstance structure.

Name	Description
`AllocatedStorage`	Specifies the allocated storage size specified in gigabytes. Type: Integer
`AutoMinorVersionUpgrade`	Indicates that minor version patches are applied automatically. Type: Boolean
`AvailabilityZone`	Specifies the name of the Availability Zone the DB Instance is located in. Type: String
`BackupRetentionPeriod`	Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer
`CharacterSetName`	If present, specifies the name of the character set that this instance is associated with. Type: String
`DBInstanceClass`	Contains the name of the compute and memory capacity class of the DB Instance. Type: String
`DBInstanceIdentifier`	Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String
`DBInstanceStatus`	Specifies the current state of this database. Type: String
`DBName`	The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String
`DBParameterGroups`	Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus list
`DBSecurityGroups`	Provides List of DB Security Group elements containing only `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements. Type: DBSecurityGroupMembership list
`DBSubnetGroup`	Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup
`Endpoint`	Specifies the connection endpoint. Type: Endpoint
`Engine`	Provides the name of the database engine to be used for this DB Instance. Type: String
`EngineVersion`	Indicates the database engine version. Type: String
`InstanceCreateTime`	Provides the date and time the DB Instance was created. Type: DateTime
`LatestRestorableTime`	Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime
`LicenseModel`	License model information for this DB Instance. Type: String
`MasterUsername`	Contains the master username for the DB Instance. Type: String
`MultiAZ`	Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean
`OptionGroupMembership`	Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership
`PendingModifiedValues`	Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues
`PreferredBackupWindow`	Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String
`PreferredMaintenanceWindow`	Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String
`ReadReplicaDBInstanceIdentifiers`	Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list
`ReadReplicaSourceDBInstanceIdentifier`	Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String

Errors

For information about the common errors that all actions use, see Common Errors.

Error	Description	HTTP Status Code
`DBInstanceNotFound`	DBInstanceIdentifier does not refer to an existing DB Instance.	404
`DBParameterGroupNotFound`	DBParameterGroupName does not refer to an existing DB Parameter Group.	404
`DBSecurityGroupNotFound`	DBSecurityGroupName does not refer to an existing DB Security Group.	404
`InsufficientDBInstanceCapacity`	Specified DB Instance class is not available in the specified Availability Zone.	400
`InvalidDBInstanceState`	The specified DB Instance is not in the available state.	400
`InvalidDBSecurityGroupState`	The state of the DB Security Group does not allow deletion.	400
`InvalidVPCNetworkState`	DB Subnet Group does not cover all availability zones after it is created because users' change.	400
`StorageQuotaExceeded`	Request would result in user exceeding the allowed amount of storage available across all DB Instances.	400

Examples

Sample Request

https://rds.amazonaws.com/
   ?Action=ModifyDBInstance
   &DBInstanceIdentifier=simcoprod01
   &AllocatedStorage=50
   &Version=2012-04-23
   &ApplyImmediately=false
   &SignatureVersion=2
   &SignatureMethod=HmacSHA256
   &Timestamp=2011-05-23T08%3A02%3A09.574Z
   &AWSAccessKeyId=<AWS Access Key ID>
   &Signature=<Signature>

Sample Response

<ModifyDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <ModifyDBInstanceResult>
    <DBInstance>
      <ReadReplicaDBInstanceIdentifiers/>
      <LatestRestorableTime>2011-05-23T08:00:00Z</LatestRestorableTime>
      <Engine>mysql</Engine>
      <PendingModifiedValues>
        <AllocatedStorage>50</AllocatedStorage>
      </PendingModifiedValues>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <MultiAZ>false</MultiAZ>
      <LicenseModel>general-public-license</LicenseModel>
      <DBInstanceStatus>available</DBInstanceStatus>
      <EngineVersion>5.1.50</EngineVersion>
      <Endpoint>
        <Port>3306</Port>
        <Address>simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com</Address>
      </Endpoint>
      <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>
      <AllocatedStorage>10</AllocatedStorage>
      <DBInstanceClass>db.m1.large</DBInstanceClass>
      <MasterUsername>master</MasterUsername>
    </DBInstance>
  </ModifyDBInstanceResult>
  <ResponseMetadata>
    <RequestId>f61a020f-8512-11e0-90aa-eb648410240d</RequestId>
  </ResponseMetadata>
</ModifyDBInstanceResponse>