rds-describe-db-instances

Description

Returns information about all DB Instances for an account if no DB Instance identifier is displayed, or displays information about a specific DB Instance.

	Note
	This command returns only active DB Instances in the current default region. To see DB Instances created in another region, you can change the region using the `--region` parameter or pass in the URL of the regional endpoint using the `--url` parameter.

Syntax

rds-describe-db-instances [DBInstanceIdentifier ]

[--max-records value ] [General Options]

Options

Name Description Required

Name	Description	Required
`DBInstanceIdentifier`	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 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: `myinstance`	No

DBInstanceIdentifier

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 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: myinstance

No

Output

The command returns 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 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 | incompatible-restore | incompatible-parameters | modifying | rebooting | resetting-master-credentials | storage-full | incompatible-parameters | incompatible-restore
Endpoint 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-immediately option 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-long view.
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). This column appears only in the --show-long view
Maintenance Window—The period during which patching and instance modifications will be performed. This column appears only in the --show-long view.
Backup Window—The daily period during which automated backups are created. This column appears only in the --show-long view.
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-long view.
Name—DB Security Group name.
Status—Status of authorization. Valid values: authorizing | authorized | revoking
Group Name—Name of DB Parameter Group applied to.
Apply Status—Status of applying the DB Parameter Group. Valid values: in-sync | pending-reboot | applying
Multi-AZ—Indicates if this is a Multi-AZ DB Instance.
EngineVersion—Database engine version number.

Examples

Get a Description of All Database Instances

This example returns a description of all DB Instances for the account.

PROMPT> rds-describe-db-instances


DBINSTANCE  mydbinstance        2010-08-04T23:27:36.420Z  db.m1.small  mysql  50
sa      available  mydbinstance.ab7c2d4uz396.us-east-1.rds.amazonaws.com        
3306  us-east-1a  3  n  5.1.49
    SECGROUP  default  active
    PARAMGRP  default.mysql5.1  in-sync
DBINSTANCE  simcoprod01         2010-08-06T07:51:10.154Z  db.m1.large  mysql  10
master  available  simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com         
3306  us-east-1a  1  n  5.1.49
    SECGROUP  default  active
    PARAMGRP  default.mysql5.1  in-sync

Get a Description of a Specific Database Instance, Showing Headers

This example returns a full description of a specific DB Instance and shows table headers

PROMPT> rds-describe-db-instances simcoprod01 --show-long --headers


DBINSTANCE,DBInstanceId,Created,Class,Engine,Storage,Master Username,Status,
Endpoint Address,Port,AZ,Backup Retention,PendingBackupRetention,PendingClass,
PendingCredentials,PendingStorage,PendingMulti-AZ,PendingVersion,DB Name,
Maintenance Window,Backup Window,Latest Restorable Time,Multi-AZ,Version,
Auto Minor Version Upgrade
DBINSTANCE,simcoprod01,2010-07-16T00:06:59.107Z,db.m1.large,mysql,60,master,avai
lable,simcoprod01.cu7u2z4zz123.us-east-1.rds.amazonaws.com,3306,us-east
-1d,1,(nil),(nil),(nil),(nil),(nil),(nil),(nil),sun:05:00-sun:09:00,23:00-01:00,
2010-08-05T00:00:00Z,n,5.1.47,n
SECGROUP,Name,Status
SECGROUP,default,active
PARAMGRP,Group Name,Apply Status
PARAMGRP,default.mysql5.1,in-sync