         | Did this page help you? Yes No Tell us about it... |
rds-modify-db-instance
Description
Changes the settings of an existing DB Instance.
Syntax
rds-modify-db-instance
DBInstanceIdentifier
[--allow-major-version-upgrade value ] [-au
(--auto-minor-version-upgrade) value ] [-v
(--engine-version) value ] [-s
(--allocated-storage) value ]
[--apply-immediately ] [-r (--backup-retention-period)
value ] [-c (--db-instance-class)
value ] [-g (--db-parameter-group-name)
value ] [-a (--db-security-groups)
value[,value...] ] [-p
(--master-user-password) value ] [-m
(--multi-az) value] [-w
(--preferred-maintenance-window) value ] [-b
(--preferred-backup-window) value ] [General
Options]
Options
| Name | Description | Required | |||
|---|---|---|---|---|---|
|
|
DB Instance identifier. This is the unique key that identifies an DB Instance. Stored as a lowercase string. Type: String Default: None Constraints: Must contain 1 to 63 (1 to 15 for SQL Server) alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: myinstance |
Yes | |||
|
|
Indicates that major version upgrades are allowed. Type: Boolean Constraints: This parameter must be set to
|
Conditional | |||
|
|
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Type: Boolean Example: |
No | |||
|
|
Version number of the database engine to use.
Type: String Example: |
No | |||
|
|
If this option is included, the database modifications will be applied immediately. If this option is omitted, the modifications will be applied during the preferred maintenance window. Modifications that can be postponed until the preferred maintenance window currently include: changing the instance class, changing the allocated storage, and changing the database engine version. Type: Boolean Default: Valid values: |
No | |||
|
|
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this options to 0 disables automatic backups. Type: Integer Default: 1 Constraints:
|
No | |||
|
|
Contains the compute and memory capacity of the DB
Instance. Different instance classes are available for different database engines.
For information about valid values for a particular engine, use the
Type: String Default: None Valid values: Example: |
No | |||
|
|
Name of the DB Parameter Group to associate with this DB Instance. Type: String Example: |
No | |||
|
|
A list of one or more DB Security Groups to associate with this DB Instance. Type: String[] Example: |
No | |||
|
|
Password for the master database user. Type: String MySQL Constraints: Must contain from 8 to 41 alphanumeric characters. Type: String Oracle Constraints: Must contain from 8 to 30 alphanumeric characters. Type: String SQL Server Constraints: Must contain from 8 to 128 alphanumeric characters. Example: |
No | |||
|
|
Specifies if this is a Multi-AZ deployment.
Type: Boolean Default: Valid values: Constraints: Cannot be specified if the DB Instance is a Read Replica. |
No | |||
|
|
Amount of storage to be initially allocated for the DB Instance, in gigabytes. MySQL Type: Integer Must be an integer from 5 to 1024. Oracle Type: Integer Must be an integer from 10 to 1024. SQL Server Type: Integer Must be an integer from 200 to 1024 (sqlserver-se and sqlserver-ee) or from 30 to 1024 (sqlserver-ex and sqlserver-web). Example: |
No | |||
|
|
Preferred maintenance window for the DB Instance. Type: String Constraints: Must be in the format ddd:hh24:mi-ddd:hh24:mi. Times should be 24-hour Universal Time Coordinated (UTC). Must be at least 30 minutes. See example below. Example: |
No | |||
|
|
The daily time range during which automated backups are
created if backups are enabled (using the
Type: String Constraints: Must be in the format hh24:mi-hh24:mi. Must be
at least 30 minutes. Times should be 24-hour Universal Time
Coordinated (UTC). Must not conflict with the
|
No |
![[Note]](http://docs.amazonwebservices.com/docs-common/images/note.png)
Output
The command returns a table that contains the following information:
DBInstanceId—User-supplied database identifier; this is the unique key that identifies a DB Instance.
Created—When the instance was created, in UTC
Class—The compute and memory capacity of the DB Instance
Engine—Name of the database engine to be used for this DB Instance
Storage—Initially allocated storage size specified in GBs
Master Username—The master username for the instance
Status—The current status of the instance. Valid values:
available|backing-up|creating|deleted|deleting|failed|modifying|rebooting|resetting-master-credentialsEndpoint Address—Address of the DB Instance
Port—Port used to connect to the DB Instance
AZ—The instance's Availability Zone
Backup Retention—The number of days that automated backups are retained before deletion
PendingClass—The class to which the instance will be scaled during the next maintenance window, or to which it is currently being scaled if the
--apply-immediatelyoption was specified.PendingCredentials—The (hidden) master user password that will be applied to the DB Instance.
PendingVersion— The pending database engine version number. This column appears only in the
--show-longview.DB Name—Name of the initial database created when the instance was created (for the MySQL engine) or the Oracle System ID (SID) of the created DB Instance (for the Oracle engine). For SQL Server, will always be null. This column appears only in the
--show-longview.Maintenance Window—The period during which patching and instance modifications will be performed. This column appears only in the
--show-longview.Backup Window—The daily period during which automated backups are created. This column appears only in the
--show-longview.Version—The version number of the database engine.
Auto Minor Version Upgrade—Indicates that minor version upgrades will be applied to the DB Instance during the maintenance window. This column appears only in the
--show-longview.License—The license model used for this DB Instance.
Name—DB Security Group name.
Status—Status of authorization. Valid values:
authorizing|authorized|revokingGroup Name—Name of DB Parameter Group applied to.
Apply Status—Status of applying the DB Parameter Group. Valid values:
in-sync|pending-reboot|applyingMulti-AZ—Indicates if this is a Multi-AZ DB Instance.
EngineVersion—Database engine version number.
Read Replica Source Identifier—The identifier of the source DB Instance for which this DB Instance acts as a Read Replica.
Name—Subnet group name
Description—Subnet group description
Status—Subnet group status
VpcId—Identifier of the VPC associated with the subnet group
Subnet identifier—Subnet group identifier
Subnet Availability Zone—Availability Zone of the subnet
Status—Status of the subnet
Examples
Associate a Security Group with a Database Instance
This example shows how to associate a DB Security Group with the specified DB Instance.
PROMPT> rds-modify-db-instance mydbinstance --db-security-groups mycoworkers
Immediately Upgrade the Instance Class of a Database Instance
This example shows how to immediately change the instance class of a DB Instance to db.m1.xlarge, with the change to take place immediately.
PROMPT> rds-modify-db-instance mydbinstance -c db.m1.xlarge --apply-immediately
Modify the Maintenance Window for a Database Instance
This shows how to change the weekly preferred maintenance window for the DB Instance to be the minimum four hour window starting Sundays at 11:15 PM, and ending Mondays at 3:15 AM.
PROMPT> rds-modify-db-instance mydbinstance -w Sun:23:15-Mon:03:15
Change the Master Password for the Database Instance
This example shows how to change the master password for a DB Instance.
PROMPT> rds-modify-db-instance mydbinstance -p a1b2c3d4
Change the Allocated Storage for a Database Instance
This example shows how to change the allocated storage for a DB Instance to 20 GB.
PROMPT> rds-modify-db-instance mydbinstance -s 20
