Amazon Relational Database Service

Amazon Relational
Database Service
Command Line Interface Reference
API Version 2014-10-31
Amazon Relational Database Service
Command Line Interface Reference
Amazon Relational Database Service: Command Line Interface
Reference
Copyright © 2017 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner
that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not
owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by
Amazon.
Amazon Relational Database Service
Command Line Interface Reference
Table of Contents
Welcome ........................................................................................................................................... 1
How Do I...? ............................................................................................................................... 1
Setting up the Command Line Tools ..................................................................................................... 2
Prerequisites .............................................................................................................................. 2
The Java Runtime Environment ............................................................................................ 3
Getting the Command Line Tools ................................................................................................. 3
Setting Up the Tools .................................................................................................................. 4
Overriding the Default Region ..................................................................................................... 4
Providing Credentials for the Tools ............................................................................................... 5
Updating to a new version of the Tools ........................................................................................ 6
API Command Line Tools Reference ..................................................................................................... 8
Common Options for API Tools .................................................................................................. 10
List of Command Line Operations by Function ............................................................................. 11
rds-add-option-to-option-group ................................................................................................. 13
Description ...................................................................................................................... 13
Syntax ............................................................................................................................. 13
Options ........................................................................................................................... 13
Output ............................................................................................................................ 14
Example .......................................................................................................................... 15
rds-add-source-identifier-to-subscription ..................................................................................... 15
Description ...................................................................................................................... 15
Syntax ............................................................................................................................. 16
Options ........................................................................................................................... 16
Output ............................................................................................................................ 16
Examples ......................................................................................................................... 17
Related Operations ........................................................................................................... 17
rds-add-tag-to-resource ............................................................................................................ 17
Description ...................................................................................................................... 18
Syntax ............................................................................................................................. 18
Options ........................................................................................................................... 18
Output ............................................................................................................................ 18
Example .......................................................................................................................... 18
rds-apply-pending-maintenance-action ....................................................................................... 19
Description ...................................................................................................................... 19
Syntax ............................................................................................................................. 19
Options ........................................................................................................................... 19
Output ............................................................................................................................ 20
Example .......................................................................................................................... 20
Related Operations ........................................................................................................... 20
rds-authorize-db-security-group-ingress ...................................................................................... 20
Description ...................................................................................................................... 20
Syntax ............................................................................................................................. 20
Options ........................................................................................................................... 21
Output ............................................................................................................................ 22
Examples ......................................................................................................................... 23
Related Operations ........................................................................................................... 23
rds-copy-db-snapshot ............................................................................................................... 23
Description ...................................................................................................................... 23
Syntax ............................................................................................................................. 23
Options ........................................................................................................................... 24
Output ............................................................................................................................ 25
Examples ......................................................................................................................... 25
Related Operations ........................................................................................................... 26
rds-copy-db-parameter-group .................................................................................................... 26
API Version 2014-10-31
iii
Amazon Relational Database Service
Command Line Interface Reference
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-copy-option-group ..............................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-create-db-instance ..............................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-create-db-instance-read-replica .............................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-create-db-parameter-group ..................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-create-db-security-group ......................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-create-db-snapshot .............................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-create-db-subnet-group .......................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-create-event-subscription .....................................................................................................
Description ......................................................................................................................
API Version 2014-10-31
iv
26
26
26
28
28
28
28
28
29
29
30
30
30
31
31
31
32
46
48
48
49
49
49
50
53
54
55
55
55
56
56
57
57
57
58
58
58
58
59
59
60
60
60
60
60
61
62
62
62
62
62
62
63
64
64
64
64
Amazon Relational Database Service
Command Line Interface Reference
Syntax ............................................................................................................................. 65
Options ........................................................................................................................... 65
Output ............................................................................................................................ 66
Examples ......................................................................................................................... 67
Related Operations ........................................................................................................... 67
rds-create-option-group ............................................................................................................ 68
Description ...................................................................................................................... 68
Syntax ............................................................................................................................. 68
Options ........................................................................................................................... 68
Output ............................................................................................................................ 69
Example .......................................................................................................................... 69
Related Operations ........................................................................................................... 69
rds-delete-db-instance .............................................................................................................. 69
Description ...................................................................................................................... 70
Syntax ............................................................................................................................. 70
Options ........................................................................................................................... 70
Output ............................................................................................................................ 71
Examples ......................................................................................................................... 72
Related Operations ........................................................................................................... 72
rds-delete-db-parameter-group .................................................................................................. 73
Description ...................................................................................................................... 73
Syntax ............................................................................................................................. 73
Options ........................................................................................................................... 73
Examples ......................................................................................................................... 73
Related Operations ........................................................................................................... 74
rds-delete-db-security-group ..................................................................................................... 74
Description ...................................................................................................................... 74
Syntax ............................................................................................................................. 74
Options ........................................................................................................................... 74
Examples ......................................................................................................................... 74
Related Operations ........................................................................................................... 75
rds-delete-db-snapshot ............................................................................................................. 75
Description ...................................................................................................................... 75
Syntax ............................................................................................................................. 75
Options ........................................................................................................................... 75
Output ............................................................................................................................ 76
Examples ......................................................................................................................... 76
Output Example .............................................................................................................. 76
Related Operations ........................................................................................................... 77
rds-delete-db-subnet-group ....................................................................................................... 77
Description ...................................................................................................................... 77
Syntax ............................................................................................................................. 77
Options ........................................................................................................................... 77
Examples ......................................................................................................................... 78
Related Operations ........................................................................................................... 78
rds-delete-event-subscription ..................................................................................................... 78
Description ...................................................................................................................... 78
Syntax ............................................................................................................................. 78
Options ........................................................................................................................... 78
Output ............................................................................................................................ 79
Examples ......................................................................................................................... 79
Related Operations ........................................................................................................... 80
rds-delete-option-group ............................................................................................................ 80
Description ...................................................................................................................... 80
Syntax ............................................................................................................................. 80
Options ........................................................................................................................... 80
Example .......................................................................................................................... 80
API Version 2014-10-31
v
Amazon Relational Database Service
Command Line Interface Reference
rds-describe-certificates ............................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
rds-describe-db-instances ..........................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-describe-db-log-files ............................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-describe-db-parameter-groups ..............................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-describe-db-parameters .......................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-describe-db-security-groups .................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-describe-db-snapshots .........................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-describe-db-engine-versions .................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
Options ...........................................................................................................................
Output ............................................................................................................................
Examples .........................................................................................................................
Related Operations ...........................................................................................................
rds-describe-db-subnet-groups ...................................................................................................
Description ......................................................................................................................
Syntax .............................................................................................................................
API Version 2014-10-31
vi
81
81
81
81
81
81
82
82
82
82
84
84
85
85
85
85
86
86
86
86
87
87
87
87
87
88
88
88
88
88
89
89
89
90
90
90
90
90
91
91
91
91
92
92
92
93
93
94
94
94
94
95
95
96
96
96
96
Amazon Relational Database Service
Command Line Interface Reference
Options ........................................................................................................................... 96
Output ............................................................................................................................ 97
Examples ......................................................................................................................... 97
Related Operations ........................................................................................................... 97
rds-describe-engine-default-parameters ..................................................................................... 98
Description ...................................................................................................................... 98
Syntax ............................................................................................................................. 98
Options ........................................................................................................................... 98
Output ............................................................................................................................ 98
Examples ......................................................................................................................... 99
Related Operations ........................................................................................................... 99
rds-describe-events ................................................................................................................... 99
Description ...................................................................................................................... 99
Syntax ............................................................................................................................. 99
Options ......................................................................................................................... 100
Output .......................................................................................................................... 101
Examples ....................................................................................................................... 101
Related Operations ......................................................................................................... 102
rds-describe-event-categories ................................................................................................... 102
Description .................................................................................................................... 102
Syntax ........................................................................................................................... 103
Options ......................................................................................................................... 103
Output .......................................................................................................................... 103
Examples ....................................................................................................................... 103
Related Operations ......................................................................................................... 103
rds-describe-event-subscriptions ............................................................................................... 104
Description .................................................................................................................... 104
Syntax ........................................................................................................................... 104
Options ......................................................................................................................... 104
Output .......................................................................................................................... 104
Examples ....................................................................................................................... 105
Related Operations ......................................................................................................... 105
rds-describe-option-group-options ............................................................................................ 105
Description .................................................................................................................... 106
Syntax ........................................................................................................................... 106
Options ......................................................................................................................... 106
Output .......................................................................................................................... 106
Example ........................................................................................................................ 107
rds-describe-option-groups ...................................................................................................... 107
Description .................................................................................................................... 107
Syntax ........................................................................................................................... 107
Options ......................................................................................................................... 108
Output .......................................................................................................................... 108
Example ........................................................................................................................ 108
rds-describe-orderable-db-instance-options ............................................................................... 109
Description .................................................................................................................... 109
Syntax ........................................................................................................................... 109
Options ......................................................................................................................... 109
Output .......................................................................................................................... 110
Examples ....................................................................................................................... 110
Related Operations ......................................................................................................... 111
rds-describe-pending-maintenance-actions ................................................................................ 111
Description .................................................................................................................... 111
Syntax ........................................................................................................................... 111
Output .......................................................................................................................... 111
Example ........................................................................................................................ 112
Related Operations ......................................................................................................... 112
API Version 2014-10-31
vii
Amazon Relational Database Service
Command Line Interface Reference
rds-describe-reserved-db-instances ...........................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-describe-reserved-db-instances-offerings ..............................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-download-db-logfile ..........................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-list-tags-for-resource .........................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Example ........................................................................................................................
rds-modify-db-instance ...........................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-modify-db-parameter-group ...............................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-modify-db-subnet-group ....................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-modify-event-subscription ..................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-promote-read-replica .........................................................................................................
Description ....................................................................................................................
API Version 2014-10-31
viii
112
112
112
113
114
115
115
115
115
115
116
117
117
118
118
118
118
118
119
119
119
119
119
120
120
120
120
120
121
121
122
132
133
134
134
134
135
135
136
136
136
136
137
137
137
137
138
138
138
138
139
139
140
140
141
141
141
Amazon Relational Database Service
Command Line Interface Reference
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Example ........................................................................................................................
rds-purchase-reserved-db-instances-offering ..............................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-reboot-db-instance ............................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-remove-option-from-option-group ......................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
rds-remove-source-identifier-from-subscription ..........................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-remove-tags-from-resource ................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Example ........................................................................................................................
rds-reset-db-parameter-group ..................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-restore-db-instance-from-db-snapshot .................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-restore-db-instance-to-point-in-time ...................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
API Version 2014-10-31
ix
141
141
142
143
143
144
144
144
145
145
146
146
146
146
146
147
148
148
148
148
148
149
149
149
150
150
150
150
151
151
152
152
152
152
152
152
153
153
153
153
153
154
154
155
155
155
155
156
161
162
163
163
163
163
164
170
172
Amazon Relational Database Service
Command Line Interface Reference
Related Operations .........................................................................................................
rds-revoke-db-security-group-ingress ........................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-watch-db-logfile ...............................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
rds-update-option-in-option-group ...........................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Example ........................................................................................................................
rds-version .............................................................................................................................
Description ....................................................................................................................
Syntax ...........................................................................................................................
Options .........................................................................................................................
Output ..........................................................................................................................
Examples .......................................................................................................................
Related Operations .........................................................................................................
Document History ..........................................................................................................................
API Version 2014-10-31
x
172
172
172
172
173
174
174
175
175
175
175
175
175
176
176
176
176
176
176
177
178
178
179
179
179
179
179
179
180
Amazon Relational Database Service
Command Line Interface Reference
How Do I...?
Welcome
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
This is the Amazon Relational Database Service Command Line Reference. This section describes who
should read this guide, how the guide is organized, and other resources related to Amazon RDS.
Amazon Relational Database Service is often referred to within this guide as "Amazon RDS"; all
copyrights and legal protections still apply.
How Do I...?
How Do I?
Relevant Sections
Download and install the Amazon RDS
command line tools.
Setting up the Command Line Tools (p. 2)
Get a list of all Amazon RDS command
line tools.
API Command Line Tools Reference (p. 8)
Get a list of Amazon RDS command line
tools by function
List of Command Line Operations by Function (p. 11)
Get a list of common options used for
all Amazon RDS command line tools
Common Options for API Tools (p. 10)
AWS provides two additional command line tools that each support a broad set of AWS services. The
AWS Command Line Interface can be used to control and automate AWS services on Windows, Mac, and
Linux. The AWS Tools for Windows PowerShell can be used with scripts in the PowerShell environment.
API Version 2014-10-31
1
Amazon Relational Database Service
Command Line Interface Reference
Prerequisites
Setting up the Command Line Tools
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Topics
• Prerequisites (p. 2)
• Getting the Command Line Tools (p. 3)
• Setting Up the Tools (p. 4)
• Overriding the Default Region (p. 4)
• Providing Credentials for the Tools (p. 5)
• Updating to a new version of the Tools (p. 6)
This section describes the prerequisites for running the command line tools, where to get the command
line tools, how to set up the tools and their environment, and includes a series of common examples of
tool usage.
Prerequisites
This document assumes you can work in a Linux/UNIX or Windows environment. The Amazon RDS
command line tools also work correctly on Mac OS X (which resembles the Linux and UNIX command
environment), but no specific Mac OS X instructions are included in this guide.
As a convention, all command line text is prefixed with a generic PROMPT> command line prompt. The
actual command line prompt on your machine is likely to be different. We also use $ to indicate a Linux/
API Version 2014-10-31
2
Amazon Relational Database Service
Command Line Interface Reference
The Java Runtime Environment
UNIX specific command and C:\> for a Windows specific command. The example output resulting from
the command is shown immediately thereafter without any prefix.
The Java Runtime Environment
The command line tools used in this guide require Java version 5, 6, or later to run. Either a JRE or JDK
installation is acceptable. To view and download JREs for a range of platforms, including Linux/UNIX and
Windows, go to http://java.sun.com/j2se/1.5.0/.
Setting the Java Home Variable
The command line tools depend on an environment variable (JAVA_HOME) to locate the Java Runtime.
This environment variable should be set to the full path of the directory that contains the Java Runtime.
Inside this directory is a sub directory named bin, which contains the executable java (on Linux and
UNIX) or java.exe (on Windows) executable. For example, on Windows this path could be C:\Program
Files (x86)\Java\jre6.
To set the Java Home variable
1.
Set the Java Home variable.
• On Linux and UNIX, using the following command:
$ export JAVA_HOME=<PATH>
• On Windows, using the following command:
C:\> setx JAVA_HOME <PATH>
• For Mac OS X versions from 10.5 and later, using the following command:
>export JAVA_HOME="$(/usr/libexec/java_home)"
2.
Confirm the path setting by running $JAVA_HOME/bin/java -version and checking the output.
• On Linux/UNIX, you will see output similar to the following:
$ $JAVA_HOME/bin/java -version
java version "1.5.0_09"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_09-b03)
Java HotSpot(TM) Client VM (build 1.5.0_09-b03, mixed mode, sharing)
• On Windows, you will see output similar to the following:
C:\> %JAVA_HOME%\bin\java -version
java version "1.5.0_09"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_09-b03)
Java HotSpot(TM) Client VM (build 1.5.0_09-b03, mixed mode, sharing)
Getting the Command Line Tools
The command line tools are available as a ZIP file on the Amazon RDS web site. These tools are written in
Java, and include shell scripts for Windows 2000/XP/Vista, Linux/UNIX, and Mac OSX. The ZIP file is selfAPI Version 2014-10-31
3
Amazon Relational Database Service
Command Line Interface Reference
Setting Up the Tools
contained and no installation is required; simply download the zip file and unzip it to a directory on your
local machine.
Setting Up the Tools
The command line tools depend on an environment variable (AWS_RDS_HOME) to locate supporting
libraries. You need to set this environment variable before you can use the tools. Set it to the path of the
directory you unzipped the command line tools into. This directory is named RDSCli-A.B.nnnn (A, B and n
are version/release numbers), and contains sub-directories named bin and lib.
To set the AWS_RDS_HOME environment variable
•
Open a command line window and enter one of the following commands to set the
AWS_RDS_HOME environment variable.
• On Linux and UNIX, enter the following command:
$ export AWS_RDS_HOME=<path-to-tools>
• On Windows, enter the following command:
C:\> setx AWS_RDS_HOME <path-to-tools>
To make the tools easier to use, we recommend you add the tools' BIN directory to your system PATH.
The rest of this guide assumes the BIN directory is in your system path.
To add the tools' BIN directory to your system path
•
Enter the following commands to add the tools' BIN directory to your system PATH.
• On Linux and UNIX, enter the following command:
$ export PATH=$PATH:$AWS_RDS_HOME/bin
• On Windows, enter the following command:
C:\> setx PATH %PATH%;%AWS_RDS_HOME%\bin
Note
The Windows environment variables are reset when you close the command window. You might
want to set them permanently. Consult the documentation for your version of Windows for
more information.
Note
Paths that contain a space must be wrapped in double quotes, for example:
"C:\Program Files\Java"
Overriding the Default Region
By default, Amazon RDS uses the us-east-1 region when you create DB instances and other Amazon RDS
objects. To temporarily specify a different region when entering an Amazon RDS command, you can use
API Version 2014-10-31
4
Amazon Relational Database Service
Command Line Interface Reference
Providing Credentials for the Tools
the --url or --region common command line options. For more information about common command
line options, see the Common Options for API Tools (p. 10).
To avoid having to pass the URL or region with each command, you can set the EC2_REGION
environment variable to the appropriate region for your use.
To override the default region
•
The following example shows how to set the default region to us-west-1.
• On Linux and UNIX, enter the following command:
$ export EC2_REGION=us-west-1
• On Windows, enter the following command:
C:\> setx EC2_REGION us-west-1
Providing Credentials for the Tools
The command line tools need the AWS Access Key and Secret Access Key provided with your AWS
account. You can get them using the command line or by using the Amazon RDS console to view your
account information.
The following procedure shows how to obtain your AWS access key and secret access key:
To get your access key ID and secret access key
Access keys consist of an access key ID and secret access key, which are used to sign programmatic
requests that you make to AWS. If you don't have access keys, you can create them by using the AWS
Management Console. We recommend that you use IAM access keys instead of AWS root account access
keys. IAM lets you securely control access to AWS services and resources in your AWS account.
Note
To create access keys, you must have permissions to perform the required IAM actions. For more
information, see Granting IAM User Permission to Manage Password Policy and Credentials in
the IAM User Guide.
1.
2.
3.
Open the IAM console.
In the navigation pane, choose Users.
Choose your IAM user name (not the check box).
4.
5.
Choose the Security Credentials tab and then choose Create Access Key.
To see your access key, choose Show User Security Credentials. Your credentials will look something
like this:
6.
• Access Key ID: AKIAIOSFODNN7EXAMPLE
• Secret Access Key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Choose Download Credentials, and store the keys in a secure location.
Your secret key will no longer be available through the AWS Management Console; you will have the
only copy. Keep it confidential in order to protect your account, and never email it. Do not share it
outside your organization, even if an inquiry appears to come from AWS or Amazon.com. No one
who legitimately represents Amazon will ever ask you for your secret key.
Related topics
API Version 2014-10-31
5
Amazon Relational Database Service
Command Line Interface Reference
Updating to a new version of the Tools
• What Is IAM? in the IAM User Guide
• AWS Security Credentials in AWS General Reference
The deployment includes a template file ${AWS_RDS_HOME}/credential-file-path.template that you
need to edit with your information. Following are the contents of the template file:
AWSAccessKeyId=<Write your AWS access ID>
AWSSecretKey=<Write your AWS secret key>
Important
On UNIX, limit permissions to the owner of the credential file:
$ chmod 600 <the file created above>
With the credentials file setup, you'll need to set the AWS_CREDENTIAL_FILE environment variable so
that the Amazon RDS tools can find your information.
To set the AWS_CREDENTIAL_FILE environment variable
1.
Set the environment variable
• On Linux and UNIX, update the variable using the following command:
$ export AWS_CREDENTIAL_FILE=<the file created above>
• On Windows, set the variable using the following command:
C:\> setx AWS_CREDENTIAL_FILE <the file created above>
2.
Check that your setup works properly, run the following command:
rds --help
You should see the usage page for all Amazon RDS commands.
Updating to a new version of the Tools
The Amazon RDS command line tools are updated with each release of RDS. Older versions of the
command line tools will no longer work with the new version of RDS. If you have a version of the
command line tools that is older than the current release of RDS, you can follow these steps to install the
latest version of the command line tools.
1.
Download the latest version of the command line tools from the Amazon RDS web site. The
download is a self-contained ZIP and no installation is required; simply download the zip file and
unzip it to a directory on your local machine.
2.
Copy the credentials file from your previous installation of the command line tools to the new
installation directory. Update the AWS_CREDENTIAL_FILE environment variable so that the Amazon
RDS tools can find your information.
Set the environment variable
API Version 2014-10-31
6
Amazon Relational Database Service
Command Line Interface Reference
Updating to a new version of the Tools
• On Linux and UNIX, update the variable using the following command:
$ export AWS_CREDENTIAL_FILE=<the new file location>
• On Windows, set the variable using the following command:
C:\> setx AWS_CREDENTIAL_FILE <the new file location>
3.
Set the AWS_RDS_HOME environment variable to the folder for the new installation directory.
• On Linux and UNIX, enter the following command:
$ export AWS_RDS_HOME=<new-path-to-tools>
• On Windows, enter the following command:
C:\> setx AWS_RDS_HOME <new-path-to-tools>
API Version 2014-10-31
7
Amazon Relational Database Service
Command Line Interface Reference
API Command Line Tools Reference
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Topics
• Common Options for API Tools (p. 10)
• List of Command Line Operations by Function (p. 11)
• rds-add-option-to-option-group (p. 13)
• rds-add-source-identifier-to-subscription (p. 15)
• rds-add-tag-to-resource (p. 17)
• rds-apply-pending-maintenance-action (p. 19)
• rds-authorize-db-security-group-ingress (p. 20)
• rds-copy-db-snapshot (p. 23)
• rds-copy-db-parameter-group (p. 26)
• rds-copy-option-group (p. 28)
• rds-create-db-instance (p. 31)
• rds-create-db-instance-read-replica (p. 49)
• rds-create-db-parameter-group (p. 55)
• rds-create-db-security-group (p. 58)
• rds-create-db-snapshot (p. 60)
• rds-create-db-subnet-group (p. 62)
• rds-create-event-subscription (p. 64)
• rds-create-option-group (p. 68)
API Version 2014-10-31
8
Amazon Relational Database Service
Command Line Interface Reference
• rds-delete-db-instance (p. 69)
• rds-delete-db-parameter-group (p. 73)
• rds-delete-db-security-group (p. 74)
• rds-delete-db-snapshot (p. 75)
• rds-delete-db-subnet-group (p. 77)
• rds-delete-event-subscription (p. 78)
• rds-delete-option-group (p. 80)
• rds-describe-certificates (p. 81)
• rds-describe-db-instances (p. 81)
• rds-describe-db-log-files (p. 85)
• rds-describe-db-parameter-groups (p. 86)
• rds-describe-db-parameters (p. 88)
• rds-describe-db-security-groups (p. 90)
• rds-describe-db-snapshots (p. 91)
• rds-describe-db-engine-versions (p. 94)
• rds-describe-db-subnet-groups (p. 96)
• rds-describe-engine-default-parameters (p. 98)
• rds-describe-events (p. 99)
• rds-describe-event-categories (p. 102)
• rds-describe-event-subscriptions (p. 104)
• rds-describe-option-group-options (p. 105)
• rds-describe-option-groups (p. 107)
• rds-describe-orderable-db-instance-options (p. 109)
• rds-describe-pending-maintenance-actions (p. 111)
• rds-describe-reserved-db-instances (p. 112)
• rds-describe-reserved-db-instances-offerings (p. 115)
• rds-download-db-logfile (p. 118)
• rds-list-tags-for-resource (p. 119)
• rds-modify-db-instance (p. 120)
• rds-modify-db-parameter-group (p. 134)
• rds-modify-db-subnet-group (p. 136)
• rds-modify-event-subscription (p. 138)
• rds-promote-read-replica (p. 141)
• rds-purchase-reserved-db-instances-offering (p. 143)
• rds-reboot-db-instance (p. 146)
• rds-remove-option-from-option-group (p. 148)
• rds-remove-source-identifier-from-subscription (p. 150)
• rds-remove-tags-from-resource (p. 152)
• rds-reset-db-parameter-group (p. 153)
• rds-restore-db-instance-from-db-snapshot (p. 155)
• rds-restore-db-instance-to-point-in-time (p. 163)
• rds-revoke-db-security-group-ingress (p. 172)
• rds-watch-db-logfile (p. 175)
API Version 2014-10-31
9
Amazon Relational Database Service
Command Line Interface Reference
Common Options for API Tools
• rds-update-option-in-option-group (p. 176)
• rds-version (p. 178)
Common Options for API Tools
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Most API tools described in this section accept the set of optional parameters described in the following
table.
Option
Description
--aws-credential-file
value
Path to the file containing your AWS credentials. This value can be
stored in the AWS_CREDENTIAL_FILE environment variable.
Example: --aws-credential-file c:\AWS\mycredemtials.pek
--ec2-cert-file-path
value
-C value
--connection-timeout
value
Path to an AWS X.509 certificate file. Must be specified in conjunction
with --ec2-private-key-file-path and must not be specified in
conjunction with --aws-credential-file. This value can be set by
using the EC2_CERT environment variable.
Specifies the connection timeout in seconds.
Default: 30
Example: --connection-timeout 60
--debug
Causes debug information to be displayed on error.
Default: false
--delimiter value
Specifies the delimiter to use when displaying long results.
Default: comma
--headers
Displays column headers for tabular or delimited results, or HTTP
headers for XML results.
Default: off
--help
Displays help text for the command. You can also use help
commandname.
Default: off
-I value
Specifies the AWS access key ID to use for requests.
--access-key-id value
API Version 2014-10-31
10
Amazon Relational Database Service
Command Line Interface Reference
List of Command Line Operations by Function
Option
Description
-K value
--ec2-private-key-filepath value
Path to an AWS X.509 private key file. Must be specified in conjunction
with --ec2-cert-file-path and must not be specified in conjunction
with --aws-credential-file. This value can be set by using the
EC2_PRIVATE_KEY environment variable.
--region value
Overrides the Region specified in the EC2_REGION environment variable.
Default: The EC2_REGION environment variable, or us-east-1 if the
EC2_REGION environment variable is not set.
Example: --region eu-west-1
-S value
Specifies the AWS secret access key to use for requests.
--secret-key-value value
--show-empty-fields
Show empty fields and rows with a (nil) value.
--show-request
Displays the URL used to call the AWS service.
--show-table
Displays the results of the command in fixed column-width format.
Empty fields are not displayed. This is the default output format.
--show-long
Displays the results of the command delimited by a character. Empty
fields are shown as "(nil). The default delimiter character is a comma.
--show-xml
Displays the results of the command as raw XML.
--quiet
Suppress all output from the command.
-U value
Override the URL for the service call with the value supplied.
--url value
This value is set using the RDS_URL environment variable.
Note
You can set the EC2_REGION environment variable or use the -region parameter to avoid having to pass the --url parameter
to specify a different regional endpoint.
List of Command Line Operations by Function
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Database Instances
• rds-create-db-instance (p. 31)
• rds-create-db-instance-read-replica (p. 49)
• rds-delete-db-instance (p. 69)
API Version 2014-10-31
11
Amazon Relational Database Service
Command Line Interface Reference
List of Command Line Operations by Function
• rds-reboot-db-instance (p. 146)
• rds-describe-db-instances (p. 81)
• rds-modify-db-instance (p. 120)
Configuration Discovery
• rds-describe-db-engine-versions (p. 94)
• rds-describe-orderable-db-instance-options (p. 109)
Reserved Database Instances
• rds-describe-reserved-db-instances-offerings (p. 115)
• rds-purchase-reserved-db-instances-offering (p. 143)
• rds-describe-reserved-db-instances (p. 112)
Database Snapshots and Point-In-Time Recovery
• rds-copy-db-snapshot (p. 23)
• rds-create-db-snapshot (p. 60)
• rds-delete-db-snapshot (p. 75)
• rds-describe-db-snapshots (p. 91)
• rds-restore-db-instance-from-db-snapshot (p. 155)
• rds-restore-db-instance-to-point-in-time (p. 163)
Parameters and Parameter Groups
• rds-create-db-parameter-group (p. 55)
• rds-delete-db-parameter-group (p. 73)
• rds-describe-db-parameters (p. 88)
• rds-describe-engine-default-parameters (p. 98)
• rds-describe-db-parameter-groups (p. 86)
• rds-modify-db-parameter-group (p. 134)
• rds-reset-db-parameter-group (p. 153)
Security Groups
• rds-create-db-security-group (p. 58)
• rds-create-db-subnet-group (p. 62)
• rds-authorize-db-security-group-ingress (p. 20)
• rds-delete-db-security-group (p. 74)
• rds-delete-db-subnet-group (p. 77)
• rds-describe-db-security-groups (p. 90)
• rds-describe-db-subnet-groups (p. 96)
• rds-modify-db-subnet-group (p. 136)
• rds-revoke-db-security-group-ingress (p. 172)
API Version 2014-10-31
12
Amazon Relational Database Service
Command Line Interface Reference
rds-add-option-to-option-group
Events
• rds-describe-events (p. 99)
Other
• rds-version (p. 178)
rds-add-option-to-option-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Adds an option to an option group.
Most options can be added and removed from option groups. Persistent options, such as the TDE option
for Microsoft SQL Server, cannot be removed from an option group while DB instances are associated
with the option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can
never 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.
For more information, see Working with Option Groups.
Syntax
rds-add-option-to-option-group option-group-name
--option-name value
[--apply-immediately]
[--security-groups value[,value2][,...]]
[--settings key1=value1;key2=value2;...]
[--port value]
[--vpc-security-group-ids value1,value2,...]
[General Options]
Options
Name
Description
Required
--option-group-name value
Name of the option group that the option will be
added to.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
API Version 2014-10-31
13
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
without a parameter name, for example: rds-addoption-to-option-group my-option-group-name.
Name of the option to be added to the option
group.
Yes
--apply-immediately
If supplied, the option will be applied immediately
for all associated DB instances. If not supplied, the
option will be applied for each DB instance during
its next maintenance window.
No
--security-groups
Name of the security group or groups that will
be applied to the port that the option uses for
communication.
Yes if the
option
uses a
port;
otherwise,
no.
--option-name
-n
-sg
--settings
-s
Provides additional information for the option
No
if the option has modifiable settings. A semicolon separated list in the form 'key1=value1;
mey2=value2; etc. If no settings are provided for
an option that requires one, the default values will
be used.
--port
A non-default port that the option will use for
communication.
No
--vpc-security-group-ids
A comma-separated list of VPC Security Group
identifiers that should be used to grant access
to the port for this option. Permission is only
granted if the option uses a port.
No
-vpcsg
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group name—The name of the option group.
• Engine—The name of the DB engine that the option group is associated with.
• Major engine version—The major version ID of the DB engine.
• Option group description—The description of the option group.
• Option name—The name of the option that was added.
• Port—The number of the port that the option will use.
• Persistent—Indicates if this is a persistent option. A persistent option cannot be removed from the
option group once the option group is used, but this option can be removed from the db instance
while modifying the related data and assigning another option group without this option.
API Version 2014-10-31
14
Amazon Relational Database Service
Command Line Interface Reference
Example
• Permanent—Indicates if this is a permanent option. A permanent option cannot be removed from
the option group once the option group is used, and it cannot be removed from the db instance after
assigning an option group with this permanent option.
• Option description—A description of the option.
• Option status—The status of authorization.
• Security group—The security group assigned to the port.
• Authorization—Status of ingress authorization for the security group.
• VPC Specific—Indicates if both VPC and non-VPC instances can join this option group.
• VPC—Indicates if only instances in this VPC can join this option group.
• Setting—The setting name that the option will use.
• Setting Description—The description of the option setting.
• Value—The value of the option setting.
• Modifiable—Indicates if the option setting is modifiable.
Example
This example adds the Oracle Enterprise Manager Database Control option to an option group named
TestOptionGroup. The default DB security group is applied to the default port:
PROMPT> rds-add-option-to-option-group TestOptionGroup --option-name OEM --security-groups
default --apply-immediately
OPTIONGROUP testoptiongroup oracle-ee 11.2 Oracle Enterprise Manager Database Control
OPTION OEM 1158 Oracle Enterprise Manager
SECGROUP
default
authorized
This example adds the Oracle time zone option to an option group named TestOptionGroup:
PROMPT> rds-add-option-to-option-group TestOptionGroup --option-name Timezone --settings
"TIME_ZONE=Japan"
rds-add-source-identifier-to-subscription
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Adds a source identifier to an existing RDS event notification subscription.
API Version 2014-10-31
15
Amazon Relational Database Service
Command Line Interface Reference
Syntax
Syntax
rds-add-source-identifier-to-subscription subscription-name
--source-id value [General Options]
Options
Name
Description
Required
--subscription-name value
The name of the subscription.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsadd-source-identifier-to-subscription mysubscription-name.
Type: String
Constraints: The name must be less than 255
characters.
Example: --subscription-name mysubscription1
--source-id value
The source identifier to be added to the
subscription. An identifier must begin with a letter
and must contain only ASCII letters, digits, and
hyphens; it cannot end with a hyphen or contain
two consecutive hyphens.
Yes
Type: String
Constraints:
If the source type is a DB instance, then a DB
instance identifier must be supplied.
If the source type is a DB security group, a DB
security group name must be supplied.
If the source type is a DB parameter group, a DB
parameter group name must be supplied.
If the source type is a DB snapshot, a DB snapshot
identifier must be supplied.
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
API Version 2014-10-31
16
Amazon Relational Database Service
Command Line Interface Reference
Examples
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• CustSubscriptionId—the Id of the event subscription
• CustomerAwsId—the AWS customer account associated with the Amazon RDS event notification
subscription
• Enabled—a Boolean value indicating if the subscription is enabled. True indicates the subscription is
enabled
• EventCategoriesList—a list of event categories for the Amazon RDS event notification subscription
• SnsTopicArn—the Amazon SNS topic's ARN for the RDS event notification subscription
• SourceIdsList—a list of source Ids for the RDS event notification subscription
• SourceType—the source type for the Amazon RDS event notification subscription
• Status—the status of the Amazon RDS event notification subscription. Can be one of the following:
creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that Amazon RDS no longer has permission to post to the
Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the
subscription was created.
• SubscriptionCreationTime—the time the RDS event notification subscription was created
Examples
Adding a source identifier to an event subscription
This example adds a DB instance named MyDBInstance1 to a subscription named MySubscription1.
PROMPT> rds-add-source-identifier-to-subscription MySubscription1 --SourceIdentifier
MyDBInstance1
Related Operations
• rds-create-event-subscription (p. 64)
• rds-remove-source-identifier-from-subscription (p. 150)
• rds-modify-event-subscription (p. 138)
• rds-describe-event-subscriptions (p. 104)
rds-add-tag-to-resource
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-file-
API Version 2014-10-31
17
Amazon Relational Database Service
Command Line Interface Reference
Description
portion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Adds a tag to an Amazon RDS resource. RDS resources can have up to 10 tags, but you can add only one
tag at a time using the command line interface. To learn how to construct the ARN that references the
DB instance to be tagged, see Constructing an RDS Amazon Resource Name (ARN).
Syntax
rds-add-tag-to-resource resource-name
--tag-key value
--tag-value value
[General Options]
Options
Name
Description
Required
--resource-name value
The Amazon Resource Name (ARN) of the Amazon Yes
RDS resource that the tag will be added to. To
learn how to construct the ARN that references
the DB instance to be tagged, see Constructing an
RDS Amazon Resource Name (ARN).
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rds-addtag-to-resource my-resource-name.
--tag-key
The name of the tag to be added.
Yes
The value of the tag to be added.
No
-tk
--tag-value
-tv
Output
This command does not return any output.
Example
The following example adds a key named "project" with a value of "trinity" to a DB instance named
mysql-db that is owned by customer 001234567890.
PROMPT> rds-add-tag-to-resource arn:aws:rds:us-west-2:001234567890:db:mysql-db -tk project
-tv trinity
API Version 2014-10-31
18
Amazon Relational Database Service
Command Line Interface Reference
rds-apply-pending-maintenance-action
rds-apply-pending-maintenance-action
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Applies a pending maintenance action to a resource. For example, you can schedule a pending
maintenance action to be applied during the next maintenance window for a DB instance.
Syntax
rds-apply-pending-maintenance-action resource-identifier
--apply-action value
--opt value
[General Options]
Options
Name
Description
Required
--resource-identifier value
The Amazon Resource Name (ARN) of the Amazon
RDS resource (for example, a DB instance) that the
pending maintenance action will be applied to.
Yes
This parameter is the default parameter and
can be passed as the first value in the command
and without a parameter name, for example:
rds-apply-pending-maintenance-action myresource-identifier.
--apply-action
-a
--opt
-o
The pending maintenance action to apply to the
resource.
Yes
A value that specifies a particular type of opt-in
request, or undoes an opt-in request. An opt-in
request of type immediate cannot be undone.
Yes
Valid values:
• immediate—Apply the maintenance action
immediately.
API Version 2014-10-31
19
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
• next-maintenance—Apply the maintenance
action during the next maintenance window for
the resource.
• undo-opt-in—Cancel any existing nextmaintenance opt-in requests.
Output
This command does not return any output.
Example
The following example immediately applies a pending operating system upgrade to a DB instance named
mysql-db that is owned by customer 001234567890.
PROMPT> rds-apply-pending-maintenance-action arn:aws:rds:us-west-2:001234567890:db:mysql-db
-a os-upgrade -o immediate
Related Operations
• rds-describe-pending-maintenance-actions (p. 111)
rds-authorize-db-security-group-ingress
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Authorizes network ingress for an Amazon EC2 security group or an IP address range.
Note
You cannot authorize ingress from an Amazon EC2 security group in one AWS region to an
Amazon RDS DB instance in another.
Syntax
rds-authorize-db-security-group-ingress db-security-group-name
API Version 2014-10-31
20
Amazon Relational Database Service
Command Line Interface Reference
Options
[-s (--ec2-security-group-id) ] value
[-g (--ec2-security-group-name) value ]
[-i (--cidr-ip) value ]
[-o (--ec2-security-group-owner-id) value ]
[General Options]
Options
Name
Description
Required
--db-security-group-name value
The name of the Amazon RDS DB security group.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsauthorize-db-security-group-ingress my-dbsecurity-group-name.
Type: String
Default: None
Example: --db-security-group-name
mydbsecuritygroup
Identifier of the Amazon EC2 security group to
authorize.
-s
--ec2-security-group-id value
No
Type: String
Default: None
Constraints: This parameter must be specified if
the DB security group is for a VPC.
Example: -g myec2securitygroup
-g
The name of the Amazon EC2 security group.
--ec2-security-group-name value
Type: String
Default: None
Constraints: This parameter must be specified
if the ec2-security-group-owner parameter
is specified. Must be an existing Amazon EC2
security group.
Example: -g myec2securitygroup
Important
Authorizing an Amazon EC2 security
group only grants access to your DB
instances from the Amazon EC2 instances
belonging to the Amazon EC2 security
group.
API Version 2014-10-31
21
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-o
The AWS account number of the owner of the
Amazon EC2 security group.
No
--ec2-security-group-owner-id
value
Type: String
Default: None
Constraints: This parameter must be specified
if the ec2-security-group-name parameter is
specified.
Example: -o 123456789012
-i
The IP range to allow access.
--cidr-ip value
Type: String
No
Constraints: Must be a valid Classless InterDomain Routing (CIDR) range, in the format
ddd.ddd.ddd.ddd/dd. For more information, see
CIDR Notation.
Default: None
Constraints: This parameter must not be specified
if the ec2-security-group-name and ec2security-group-owner parameters are specified.
Example: -i 192.168.100.100/32
Warning
To avoid inadvertently granting access to
your DB instances, be sure to understand
how CIDR ranges work. For more
information about CIDR ranges, go to the
Wikipedia Tutorial .
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
•
•
•
•
Name—Security group name.
Description—Security group description.
EC2 Group Name—Name of the EC2 security group./
EC2 Group Id—Identifier of the EC2 security group./
• EC2 Owner ID—Owner of the EC2 security group.
• IP Range—CIDR range for the authorized Amazon RDS security group.
• Status—Status of the authorization.
API Version 2014-10-31
22
Amazon Relational Database Service
Command Line Interface Reference
Examples
Examples
Authorizing Access to an EC2 Security Group
This example authorizes access to a named Amazon EC2 security group.
PROMPT> rds-authorize-db-security-group-ingress Default --ec2-security-group-name
mainServerGrp --ec2-security-group-owner-id 123445677890
Authorizing Access to a CIDR range
This example authorizes access to a CIDR range.
PROMPT> rds-authorize-db-security-group-ingress Default --cidr-ip 192.168.100.100/32
Related Operations
• rds-revoke-db-security-group-ingress (p. 172)
rds-copy-db-snapshot
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a copy of all data and configuration associated with the specified DB snapshot. You can copy an
automated DB snapshot to create a manual DB snapshot in the same region, the manual snapshot will
be retained after the automated snapshot is deleted. You can also copy either a manual or automated
snapshot in one region to create a manual snapshot in another region.
Copying a DB snapshot out of the source region incurs Amazon RDS data transfer charges. For more
information about RDS data transfer pricing, go to Amazon Relational Database Service Pricing.
Note
You cannot copy a DB snapshot to or from the AWS GovCloud (US) Region. You also cannot copy
a DB snapshot across regions if it was created from a DB instance that is using Oracle TDE.
Syntax
rds-copy-db-snapshot source-db-snapshot-identifier
-t (--target-db-snapshot-identifier) value
API Version 2014-10-31
23
Amazon Relational Database Service
Command Line Interface Reference
Options
[-ct (--copy-tags) value ]
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
--source-db-snapshotidentifier value
Source DB snapshot identifier. This is the unique
name that identifies an existing DB snapshot to copy.
Yes
-s value
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rds-copydb-snapshot my-source-db-snapshot-identifier.
Type: String
Default: None
Constraints:
• Must specify a valid DB snapshot in the active state.
• If the source snapshot is in the same region as the
copy command, must specify a valid DB snapshot
identifier.
Example: --source-db-instance-identifier
mydbsnapshot
• If the source snapshot is in a different region,
must specify a valid DB snapshot ARN. For more
information, go to Copying a DB Snapshot.
Example: --source-db-instanceidentifier arn:aws:rds:useast-1:123456789012:snapshot:mysql-instance1snapshot-20130805
-t value
The identifier for the target DB snapshot.
--target-db-snapshotidentifier value
Type: String
Yes
Default: None
Constraints: Cannot be null, empty, or blank. Cannot
be a word reserved by the database engine. Must
contain 1 to 255 alphanumeric characters or hyphens.
First character must be a letter. Cannot end with a
hyphen or contain two consecutive hyphens.
Example: -t my-copied-snapshot-id
--copy-tags
-ct
True to copy all tags from the source DB snapshot to
the target DB snapshot; otherwise false. The default
is false.
API Version 2014-10-31
24
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
--tag-key
The name of a tag to add for the target DB snapshot.
No
The value of the tag to add for the target DB
snapshot.
No
-tk
--tag-value
-tv
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• DBSnapshotId—Name of the DB snapshot
• Snapshot Created—The time (in 24 hour UTC) when the DB snapshot was taken
• DBInstanceId—User-supplied database identifier; this is the unique key that identifies a DB instance
• Instance Created—The date and time when the DB instance was created
• Engine—The name and version of the database engine used
• Storage—The size of the DB snapshot's allocated storage (GB)
• Storage Type—The storage type of the DB snapshot
• Encrypted—Indicates whether the DB snapshot is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB snapshot
• Status—Status of the DB snapshot. Valid values: creating | available | deleting
• Master Username—The login name of the database's master user.
• AZ—The original Availability Zone of the database from which the DB snapshot was taken. This
column appears only in the --show-long view
• Port—The original port of the database from which the DB snapshot was taken. This column appears
only with the --show-long-view command option
• Version—The database engine's version number.
• License—TBD
• Type—TBD
• VpcId—TBD
Examples
Copy a Database Snapshot
This example copies an automated DB snapshot to create a manual DB snapshot in the same region.
PROMPT> rds-copy-db-snapshot -s rds:mydb-2012-01-15-00-01 -t snapshotdec01
API Version 2014-10-31
25
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
Copy a DB Snapshot Across Regions
This example copies a manual DB snapshot in the us-east-1 region to create a manual DB snapshot in the
us-west-2 region.
PROMPT> rds-copy-db-snapshot --source-db-snapshot-identifier arn:aws:rds:useast-1:123456789012:snapshot:mysql-instance1-snapshot-20130805 --region us-west-2 --targetdb-snapshot-identifier mysql-instance1-snapshot-20130805-copy
Related Operations
• rds-delete-db-snapshot (p. 75)
• rds-describe-db-snapshots (p. 91)
• rds-restore-db-instance-from-db-snapshot (p. 155)
rds-copy-db-parameter-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a copy of the specified DB parameter group.
Syntax
rds-copy-db-parameter-group source-db-parameter-group-identifier
-t (--target-db-parameter-group-identifier) value
-td (--target-db-parameter-group-description) value
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
--source-db-parametergroup-identifier value
The identifier of the source DB parameter group.
This unique name or ARN identifies an existing DB
parameter group to copy.
Yes
-s value
API Version 2014-10-31
26
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rds-copydb-parameter-group my-source-db-parametergroup-identifier.
Type: String
Default: None
Constraints:
• Must specify a valid DB parameter group.
• If the source DB parameter group is in the same
region as the copy, specify a valid DB parameter
group identifier, for example my-db-parametergroup.
• If the source DB parameter group is in a different
region than the copy, specify a valid DB parameter
group ARN, for example arn:aws:rds:uswest-2:123456789012:og:special-parameters, or
a valid ARN.
--target-db-parametergroup-identifier value
-t value
The identifier for the DB parameter group to create.
Yes
Type: String
Default: None
Constraints:
• Cannot be null, empty, or blank.
• Must contain 1 to 255 alphanumeric characters or
hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two
consecutive hyphens.
Example: -t my-copied-db-parameter-group-id
--target-db-parametergroup-description value
-td value
--tag-key
-tk
--tag-value
-tv
A description of the DB parameter group to create.
Yes
Type: String
Default: None
The name of a tag to add for the DB parameter
group.
No
The value of the tag to add for the DB parameter
group.
No
API Version 2014-10-31
27
Amazon Relational Database Service
Command Line Interface Reference
Output
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group name—The name of the new DB parameter group.
• Parameter group family—Parameter group family to which the new DB parameter group applies.
• Description—The description of the new DB parameter group.
Examples
Copy a DB Parameter Group
The following example copies a DB parameter group and creates a new DB parameter group in the same
region.
PROMPT> rds-copy-db-parameter-group my-source-db-parameter-group -t my-new-db-parametergroup -td "My new DB parameter group"
Related Operations
• rds-create-db-parameter-group (p. 55)
• rds-delete-db-parameter-group (p. 73)
• rds-modify-db-instance (p. 120)
• rds-describe-db-parameter-groups (p. 86)
rds-copy-option-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a copy of the specified option group.
API Version 2014-10-31
28
Amazon Relational Database Service
Command Line Interface Reference
Syntax
Syntax
rds-copy-option-group source-option-group-identifier
-t (--target-option-group-identifier) value
-td (--target-option-group-description) value
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
--source-option-groupidentifier value
Source option group identifier. This unique name or
ARN identifies an existing option group to copy.
Yes
-s value
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-copy-optiongroup my-source-option-group-identifier.
Type: String
Default: None
Constraints:
• Must specify a valid option group.
• If the source option group is in the same region as
the copy, specify a valid option group identifier, for
example my-option-group, or a valid ARN.
• If the source option group is in a different
region than the copy, specify a valid option
group ARN, for example arn:aws:rds:uswest-2:123456789012:og:special-options.
--target-option-groupidentifier value
-t value
The identifier for the option group to create.
Type: String
Default: None
Constraints:
• Cannot be null, empty, or blank.
• Must contain 1 to 255 alphanumeric characters or
hyphens.
• First character must be a letter.
• Cannot end with a hyphen or contain two
consecutive hyphens.
Example: -t my-copied-option-group-id
API Version 2014-10-31
29
Yes
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
--target-option-groupdescription value
The description of the option group to create.
Yes
-td value
--tag-key
Type: String
Default: None
The name of a tag to add for the new option group.
No
The value of the tag to add for the new option group.
No
-tk
--tag-value
-tv
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group name—The name of the new option group.
• Engine—The name of the DB engine that the new option group is associated with.
• Major engine version—The major version ID of the DB engine.
• Description—The description of the new option group.
Examples
Copy an Option Group
The following example copies an option group and creates a new option group in the same region.
PROMPT> rds-copy-option-group my-source-option-group -t my-new-option-group -td "My new
option group"
Related Operations
• rds-create-option-group (p. 68)
• rds-delete-option-group (p. 80)
• rds-modify-db-instance (p. 120)
• rds-describe-option-groups (p. 107)
API Version 2014-10-31
30
Amazon Relational Database Service
Command Line Interface Reference
rds-create-db-instance
rds-create-db-instance
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a new DB instance.
Syntax
rds-create-db-instance db-instance-identifier
[-a (--db-security-groups) value[,value...] ]
[-sg (--vpc-security-group-ids) value[,value...] ]
[-au (--auto-minor-version-upgrade) value ]
[-b (--preferred-backup-window) value ]
-c (--db-instance-class) value
[-cs (--character-set) value ]
[-ct (--copy-tags-to-snapshot) value ]
-e (--engine) value
[-g (--db-parameter-group-name) value]
[--iops value ]
[-st (--storage-type) value ]
[-se (--storage-encrypted) value ]
[--kms-key-id value ]
-lm (--license model) value
[-m (--multi-az) value]
[-n (--db-name) value ]
[-og (--option-group) value ]
-p (--master-user-password) value
[--port value ]
[-r (--backup-retention-period) value ]
-s (--allocated-storage) value
[-sn (--db-subnet-group-name) value ]
-u (--master-username) value
API Version 2014-10-31
31
Amazon Relational Database Service
Command Line Interface Reference
Options
[-v (--engine-version) value ]
[-w (--preferred-maintenance-window) value]
[-pub (--publicly-accessible) value ]
[-tca (--tde-credential-arn) value ]
[-tcp (--tde-credential-password) value ]
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[-z (--availability-zone) value ]
[General Options]
Options
Name
Description
Required
--db-instance-identifier value
DB instance identifier. This is the unique key that
identifies a DB instance. This parameter is stored
as a lowercase string.
Yes
-D value
This parameter is the default parameter and
can be passed as the first value in the command
and without a parameter name, for example:
rds-create-db-instance my-db-instanceidentifier.
Type: String
Default: None
Constraints: Must contain from 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
-c value
--db-instance-class value
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 rds-describe-orderable-dbinstance-options (p. 109) command.
Type: String
Default: None
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
| db.cr1.8xlarge | db.m3.medium | db.m3.large
| db.m3.xlarge | db.m3.2xlarge | db.r3.large |
API Version 2014-10-31
32
Yes
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge
| db.r3.8xlarge | db.t2.micro | db.t2.small
| db.t2.medium | db.t2.large | db.m4.large |
db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge |
db.m4.10xlarge
Example: --db-instance-class db.m1.xlarge
Note
Amazon RDS does not support
db.t1.micro instances in a virtual private
cloud (VPC).
--copy-tags-to-snapshot
-ct
-cs value
--character-set value
True to copy all tags from the DB instance to
snapshots of the DB instance; otherwise false. The
default is false.
No
Specifies the Oracle character set that the DB
instance will use. For a list of supported character
sets, go to Appendix: Oracle Character Sets
Supported in Amazon RDS. Oracle only.
No
API Version 2014-10-31
33
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-n value
The value of this parameter differs according to
the DB engine you use.
No
--db-name value
MySQL
Name of a database to create when the DB
instance is created. If this parameter is not
specified, no database is created on the instance.
Constraints:
• Must contain 1 to 64 alphanumeric characters.
• Cannot be a word reserved by the specified
database engine.
Type: String
PostgreSQL
Name of a database to create when the DB
instance is created. If this parameter is not
specified, the default "postgres" database is
created on the instance.
Constraints:
• Must contain 1 to 63 alphanumeric characters.
• Cannot be a word reserved by the specified
database engine.
Type: String
Example: --db-name pgDatabase
Oracle
The Oracle System ID (SID) of the created DB
instance.
Constraints:
• Cannot be longer than 8 characters.
Type: String
Example: --db-name MYORACLE
SQL Server
Not applicable.
API Version 2014-10-31
34
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-e value
Name of the database engine to be used for this
instance.
Yes
--engine value
Type: String
Default: None
Valid values: aurora | mariadb | MySQL | postgres |
oracle-ee | oracle-se | oracle-se1 | oracle-se2
| sqlserver-ee | sqlserver-se | sqlserver-ex |
sqlserver-web
-v value
Version number of the database engine to use.
--engine-version value
Type: String
-g value
Name of the DB parameter group to associate
with this DB instance. If this argument is omitted,
the default DBParameterGroup for the specified
engine will be used.
--db-parameter-group-name value
No
No
Type: String
Example: --db-parameter-group-name
MyDBParameterGroup
-lm
License model for this DB instance.
--license-model value
Type: String
No
Default: None
Valid values: license-included | bring-your-ownlicense | general-public-license
Example: --license-model bring-your-own
-m value
--multi-az value
Specifies if this is a Multi-AZ deployment. Not a
valid option for SQL Server Multi-AZ mirrored
instances. To configure Multi-AZ for a SQL Server
instance, apply or remove the "Mirroring" option
using Option Groups.
Type: Boolean
Default: false
Constraints: The --availability-zone parameter
cannot be set if the --multi-az parameter is set
to true.
Valid values: true | false
API Version 2014-10-31
35
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
--iops value
Specifies the amount of Provisioned IOPS for
the DB instance, expressed in I/O operations per
second.
No
Constraints: Must be an integer greater than 1000
if you are setting a value for Provisioned IOPS.
The value must also be a multiple of the storage
amount for the DB instance and can be from 3-10
times the storage amount. For example, if the
size of your DB instance is 500GB, then your -iops value can be 2000, 3000, 4000, or 5000.
See the RDS User Guide for more information on
setting Provisioned IOPS values for a particular
DB instance type.
-st value
Specifies the storage type for the DB instance.
--storage-type value
Type: String
No
Valid values: standard | gp2 | io1.
Default: io1 if the --iops parameter is specified;
otherwise standard
If you specify io1, you must also include a value
for the --iops parameter.
-se value
Specifies whether the DB instance is encrypted.
--storage-encrypted value
Type: Boolean
No
Default: false
-tca value
--tde-credential-arn value
-tcp value
--tde-credential-password value
The ARN of the HSM HA Partition Group used for
the TDE HSM option.
No
The password of the HSM HA Partition Group
used for the TDE HSM option.
No
API Version 2014-10-31
36
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
--kms-key-id value
The KMS key identifier for an encrypted DB
No
instance. This is the Amazon Resource Name (ARN)
for the KMS encryption key. If you are creating
a DB instance with the same AWS account that
owns the KMS encryption key used to encrypt the
new DB instance, then you can use the KMS key
alias instead of the ARN for the KMS encryption
key.
-key value
Required
Type: String
If --storage-encrypted is true, and you do not
specify a value for the --kms-key-id parameter,
then Amazon RDS will use your default encryption
key. AWS KMS creates the default encryption key
for your AWS account. Your AWS account has a
different default encryption key for each AWS
region.
-a value
--db-security-groups value
[,value...]
A list of one or more DB security groups to
associate with this DB instance.
No
Type: String[]
Example: --db-security-groups
mysecuritygroup1, mysecuritygroup2
-sg value
--vpc-security-group-ids value
[,value...]
A list of the IDs of one or more VPC security
groups to associate with this DB instance.
Type: String[]
Example: --vpc-security-group-ids sge763f78e, sg-e0690405
API Version 2014-10-31
37
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
--port value
Port number that the DB instance uses for
connections.
No
Type: Integer
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
Type: Integer
Example: --port 1234
SQL Server
Default: 1433
Valid Values: 1150-65535 except for 1434, 3389,
47001, 49152, and 49152 through 49156.
Type: Integer
API Version 2014-10-31
38
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-s value
Amount of storage to be initially allocated for the
DB instance, in gigabytes.
Yes
--allocated-storage value
Type: String
MySQL and PostgreSQL
Constraints: Must be an integer between 5 and
6144.
Oracle
Constraints: Must be an integer between 10 and
6144.
SQL Server
Constraints: Must be an integer from 200 to 4096
(sqlserver-se and sqlserver-ee) or from 20 to 4096
(sqlserver-ex and sqlserver-web).
Example: --allocated-storage 320
-au value
--auto-minor-version-upgrade
value
Indicates that minor version upgrades will be
applied automatically to the DB instance during
the maintenance window.
Type: Boolean
Default: true
Example: -au true
API Version 2014-10-31
39
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-u value
The name of the master database user.
Yes
--master-username value
Type: String
MySQL
Constraints:
• Must be an alphanumeric string containing from
1 to 16 characters
• First character must be a letter
• Cannot be a reserved word for the chosen
database engine
Oracle
Constraints:
• Must be an alphanumeric string containing from
1 to 30 characters
• First character must be a letter
• Cannot be a reserved word for the chosen
database engine
SQL Server
Constraints:
• Must be 1 to 128 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen
database engine.
PostgreSQL
Constraints:
• Must be 1 to 63 alphanumeric characters.
• First character must be a letter.
• Cannot be a reserved word for the chosen
database engine.
Example: --master-username SQLDBA1
API Version 2014-10-31
40
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-og value
The name of the option group to be associated
with this instance. If this parameter is not
provided, the default option group for the engine
specified is used.
No
--option-group value
Note that persistent options, such as the TDE
option for Microsoft SQL Server, cannot be
removed from an option group while DB instances
are associated with the option group. Permanent
options, such as the TDE option for Oracle
Advanced Security TDE, can never 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.
-p value
--master-user-password value
Password for the master DB instance user. Can be
any printable ASCII character except "/" or "@".
If this parameter is not provided, the user will be
prompted to enter a password.
MySQL
Constraints: Must contain from 8 to 41 characters.
Type: String
Oracle
Constraints: Must contain from 8 to 30 characters.
Type: String
SQL Server
Constraints: Must contain from 8 to 128
characters.
PostgreSQL
Constraints: Must be 8 to 128 alphanumeric
characters
Example: --master-user-password
mysecretpassword01
API Version 2014-10-31
41
Yes
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-w value
Weekly time range (in UTC) during which system
maintenance can occur. For more information
about the maintenance window, see the Amazon
RDS User Guide.
No
--preferred-maintenance-window
value
Type: String
Default: A 30-minute window selected at random
from an 8-hour block of time per region, occurring
on a random day of the week. The following list
shows the time blocks for each region from which
the default maintenance windows are assigned.
Default: Depends on the Region the database was
created in. The following table lists the default
maintenance window for each Region.
Region
Time Block
US West
(Oregon)
Region
06:00–14:00 UTC
US West (N.
California)
Region
06:00–14:00 UTC
US East
(Ohio)
Region
03:00–11:00 UTC
US East (N.
Virginia)
Region
03:00–11:00 UTC
Asia Pacific
(Mumbai)
Region
17:30–01:30 UTC
Asia Pacific
(Seoul)
Region
13:00–21:00 UTC
Asia Pacific
(Singapore)
Region
14:00–22:00 UTC
Asia Pacific
(Sydney)
Region
12:00–20:00 UTC
Asia Pacific
(Tokyo)
Region
13:00–21:00 UTC
API Version 2014-10-31
42
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
Region
Time Block
Canada
(Central)
Region
06:29–14:29 UTC
EU
(Frankfurt)
Region
23:00–07:00 UTC
EU (Ireland)
Region
22:00–06:00 UTC
EU (London)
Region
06:00–14:00 UTC
South
America
(São Paulo)
Region
00:00–08:00 UTC
AWS
GovCloud
(US)
06:00–14:00 UTC
Constraints:
• Must not conflict with the preferred backup
window for this DB instance.
• Must be at least 30 minutes.
• Must be in the format ddd:hh24:middd:hh24:mi.
• Times should be Universal Time Coordinated
(UTC). See example below.
Example: --preferred-maintenance-window
Tue:00:30-Tue:04:30
API Version 2014-10-31
43
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-b value
The daily time range (in UTC) during which
automated backups are created if backups are
enabled (using the --backup-retention-period)
parameter. For more information about the
backup window, see the Amazon RDS User Guide.
No
--preferred-backup-window value
Type: String
Default: A 30-minute window selected at random
from an 8-hour block of time per region. The
following table lists the time blocks for each
region from which the default backup windows
are assigned.
Default: Depends on the Region the database was
created in. The following table lists the default
backup window for each Region.
Region
Time Block
US West
(Oregon)
Region
06:00–14:00 UTC
US West (N.
California)
Region
06:00–14:00 UTC
US East
(Ohio)
Region
03:00–11:00 UTC
US East (N.
Virginia)
Region
03:00–11:00 UTC
Asia Pacific
(Mumbai)
Region
16:30–00:30 UTC
Asia Pacific
(Seoul)
Region
13:00–21:00 UTC
Asia Pacific
(Singapore)
Region
14:00–22:00 UTC
Asia Pacific
(Sydney)
Region
12:00–20:00 UTC
Asia Pacific
(Tokyo)
Region
13:00–21:00 UTC
API Version 2014-10-31
44
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
Region
Time Block
Canada
(Central)
Region
06:29–14:29 UTC
EU
(Frankfurt)
Region
20:00–04:00 UTC
EU (Ireland)
Region
22:00–06:00 UTC
EU (London)
Region
06:00–14:00 UTC
South
America
(São Paulo)
Region
23:00–07:00 UTC
AWS
GovCloud
(US)
03:00–11:00 UTC
Constraints:
• Must not conflict with the preferred
maintenance window for this DB instance.
• Must be in the format hh24:mi-hh24:mi.
• Times should be 24-hour Universal Time
Coordinated (UTC).
• Must not conflict with the --preferredmaintenance-window.
• Must be at least 30 minutes.
-r value
--backup-retention-period value
The number of days automated backups are
retained. Setting this parameter to a positive
number enables backups. Setting this parameter
to 0 disables backups.
Type: Integer
Default: 1
Constraints:
• Must be a value from 0 to 35.
• Cannot be set to 0 if the DB instance is a source
to Read Replicas.
API Version 2014-10-31
45
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-z value
The Amazon EC2 Availability Zone where the DB
instance will be created. For more information
about Availability Zones, see the Amazon RDS
User Guide.
No
--availability-zone value
Type: String
Default: A random, system-chosen Availability
Zone in the same region as the current endpoint.
Constraints: The --availability-zone parameter
cannot be set if the --multi-az parameter is set
to true.
Example: --availability-zone us-east-1a
-sn value
--db-subnet-group-name value
The name of the DB subnet group to associate
with this DB instance. Specifying a DB subnet
group will create this DB instance in the VPC
associated with the DB subnet group.
No
Type: String
Default: none
Constraints: Must be the name of an existing DB
subnet group.
Example: --db-subnet-group-name
mydbsubnetgroup
-pub value
--publicly-accessible value
--tag-key
Specifies the accessibility options for the DB
instance. A value of true specifies an Internetfacing instance with a publicly resolvable DNS
name, which resolves to a public IP address. A
value of false specifies an internal instance with a
DNS name that resolves to a private IP address.
No
The name of a tag to add for the new DB instance.
No
The value of the tag to add for the new DB
instance.
No
-tk
--tag-value
-tv
Output
The command returns a table that contains the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
API Version 2014-10-31
46
Amazon Relational Database Service
Command Line Interface Reference
Output
• DBInstanceID—The user-supplied DB instance identifier
• Created—The data and time the instance was created, in 24-hour UTC
• Class—The compute and memory capacity of the instance
• CopyTagsToSnapshot—Specifies whether tags are copied from the DB instance to snapshots of the DB
instance.
• Engine—Name of the database engine to be used for this DB instance
• License Model—The license model used for this DB instance
• Storage—Initially allocated storage size specified in gigabytes (GBs)
• Storage Type—The type of storage specified
• Storage Encrypted—Indicates whether the DB instance is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB instance
• Resource Id—If Storage Encrypted is true, the region-unique, immutable identifier for the encrypted
DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB
instance is accessed.
• Master Username—The master username for the DB instance
• Status—The current status of the DB instance. Valid values: available | backing-up | creating |
deleted | deleting | failed | 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
• PendingBackupRetention—The backup retention period which will be applied at the next
maintenance window, or which is currently being applied if the --apply-immediately option was
specified
• 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
• PendingStorage—The storage size 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
• PendingMulti-AZ—If true, indicates the instance will be converted to run as a Multi-AZ deployment; if
false, the instance will be converted to run as a standard (Single-AZ) deployment.
• PendingVersion—The engine version of the pending database instance.
• SecondaryAvailabilityZone—If present, specifies the name of the secondary Availability Zone for a DB
instance with multi-AZ support.
• Iops—The provisioned IOPS allocated, expressed as I/O operations per second.
• DB Name—Name of the initial database created when the instance was created 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-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 period during which automated backups are created. This column appears only
in the --show-long view
• Latest Restorable Time—The latest time to which a database can be restored using point-in-time
restore. This column appears only in the --show-long view.
• Multi-AZ—Indicates if this is a Multi-AZ DB instance.
API Version 2014-10-31
47
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Publicly Accessible—Indicates the accessibility option of the instance. A value of true specifies an
Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A
value of false specifies an internal instance with a DNS name that resolves to a private IP address.
• EngineVersion—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—The DB security group name
• Group Name—Name of DB parameter group applied to
• Apply Status—Status of applying the parameter group. It can be either in-sync or pending-reboot
• Read Replica ID—The identifier of a DB instance which acts as a Read Replica of this DB instance
• Name—Subnet group name
• Description—Subnet group description
• VpcId—Identifier of the VPC associated with the subnet group
• VPC Security Group Ids—Identifier of the VPC security groups associated with the instance.
• Subnet identifier—Subnet group identifier
• Subnet Availability Zone—Availability Zone of the subnet
Examples
Create a Database Instance with Minimal Parameters
This example creates a DB instance with the minimal set of parameters.
PROMPT> rds-create-db-instance SimCoProd01 -s 10 -c db.m1.large -e mysql -u master -p
Kew2401Sd
Create an Oracle Database Instance
This example creates a DB instance with the minimal set of parameters.
PROMPT> rds-create-db-instance SimCoProd01 -s 10 -c db.m1.large -e oracle-se --db-name
MYORACLE -lm bring-your-own-license -u master -p Kew2401Sd
Create a Database Instance and Prompt for a Password
This example creates a database, prompting for the master user password.
PROMPT> rds-create-db-instance SimCoProd02 -s 10 -c db.m1.large -e mysql -u master -p
Related Operations
• rds-describe-db-instances (p. 81)
API Version 2014-10-31
48
Amazon Relational Database Service
Command Line Interface Reference
rds-create-db-instance-read-replica
• rds-modify-db-instance (p. 120)
• rds-delete-db-instance (p. 69)
rds-create-db-instance-read-replica
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a DB instance that acts as a Read Replica of a source DB instance.
Note
Read Replicas are only supported for the MySQL and PostgreSQL DB engines.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other
DB instance attributes (including DB security groups and DB parameter groups) are inherited from the
source DB instance, except where specified otherwise.
Syntax
rds-create-db-instance-read-replica db-instance-identifier
-s (--source-db-instance-identifier) value
[-c (--db-instance-class) value ]
[-ct (--copy-tags-to-snapshot) value ]
[-au (--auto-minor-version-upgrade) value ]
[-st (--storage-type) value ]
[--iops value ]
[-og (--option-group) value ]
[--pub (--publicly-accessible) value ]
[-z (--availability-zone) value ]
[-p (--port) value ]
[-n (--db-subnet-group-name) value ]
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
API Version 2014-10-31
49
Amazon Relational Database Service
Command Line Interface Reference
Options
[General Options]
Options
Name
Description
Required
--db-instance-identifier value
DB instance identifier of the Read Replica. This is
the unique key that identifies a DB instance. This
parameter is stored as a lowercase string.
Yes
-i value
This parameter is the default parameter and
can be passed as the first value in the command
and without a parameter name, for example:
rds-create-db-instance-read-replica my-dbinstance-identifier.
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
-s value
--source-db-instance-identifier
value
The identifier of the DB instance for which this DB
instance will act as a Read Replica. You can have
up to 5 Read Replicas per DB instance.
Yes
Type: String
Constraints:
• If the source DB instance is in the same region
as the Read Replica, must be the identifier of
an existing DB instance. If the source is in a
different region, must specify the ARN of the
source instance. For more information about
ARNs, go to Constructing an Amazon RDS
Amazon Resource Name (ARN).
• Can specify a DB instance that is a Read Replica
only if the source is running MySQL 5.6,
PostgreSQL 9.3.5, 9.3.6, 9.3.9, 9.3.10, 9.4.1,
9.4.4, and 9.4.5.
• The specified source DB instance must have
backups enabled, its backup retention period
must be greater than 0.
-c value
--db-instance-class value
Contains the compute and memory capacity of
the Read Replica.
API Version 2014-10-31
50
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
Type: String
Default: Inherits from the source DB instance.
Different instance classes are available for
different database engines. For information
about valid values for a particular engine, use
the rds-describe-orderable-db-instanceoptions (p. 109) command.
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
| db.m3.medium | db.m3.large | db.m3.xlarge |
db.m3.2xlarge | db.r3.large | db.r3.xlarge |
db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge
| db.t2.micro | db.t2.small | db.t2.medium
| db.t2.large | db.m4.large | db.m4.xlarge
| db.m4.2xlarge | db.m4.4xlarge |
db.m4.10xlarge
Example: --db-instance-class db.m1.xlarge
Example: --db-instance-class db.m1.xlarge
Note
Amazon RDS does not support
db.t1.micro instances in a virtual private
cloud (VPC).
--copy-tags-to-snapshot
-ct
-og value
--option-group value
-p value
--port value
True to copy all tags from the Read Replica to
snapshots of the Read Replica; otherwise false.
The default is false.
No
The name of the option group to be associated
with this Read Replica. If this parameter is not
provided, the default option group for the engine
specified is used.
No
Port number that the Read Replica uses for
connections.
No
Type: Integer
Default: Inherits from the source DB instance
Example: --port 1234
-au value
--auto-minor-version-upgrade
value
Indicates that minor engine upgrades will be
applied automatically to the Read Replica during
the maintenance window.
Type: Boolean
Default: Inherits from the source DB instance
Example: -au true
API Version 2014-10-31
51
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-st value
Specifies the storage type for the DB instance.
No
--storage-type value
Type: String
Valid values: standard | gp2 | io1.
Default: io1 if the --iops parameter is specified;
otherwise standard
If you specify io1, you must also include a value
for the --iops parameter.
--iops value
Specifies the amount of provisioned IOPS for
the DB instance, expressed in I/O operations per
second.
No
If this parameter is not specified, the IOPS
value will be taken from the master. If this
parameter is set to 0, the new instance will not
have provisioned IOPS.
Constraints: Must be an integer greater than
1000.
-pub value
--publicly-accessible value
-z value
--availability-zone value
Specifies the accessibility options for the DB
instance. A value of true specifies an Internetfacing instance with a publicly resolvable DNS
name, which resolves to a public IP address. A
value of false specifies an internal instance with a
DNS name that resolves to a private IP address.
No
The Amazon EC2 Availability Zone that the Read
Replica will be created in.
No
Type: String
Default: A random, system-chosen Availability
Zone in the same region as the current endpoint.
Constraints: The --availability-zone parameter
cannot be set if the --multi-az parameter is set
to true.
Example: --availability-zone us-east-1a
API Version 2014-10-31
52
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-n value
The name of a DB subnet group associated with
the Amazon VPC in which you want the Read
Replica to be created. If a DB subnet group name
is not specified, the Read Replica will be created
outside of any VPC.
No
--db-subnet-group-name value
Type: String
Default: none.
Constraints:
• Can only be specified if --source-db-instanceidentifier references an instance in another
region.
• The specified DB subnet group must be in the
same region in which the command is running.
For example, if you specify --region uswest-2, then the DB subnet group must be in
the us-west-2 region.
• All of the Read Replicas in one region that are
created from the same source DB instance in
another region must either:
• Specify DB subnet groups from the same VPC.
These Read Replicas will be created in the
same VPC.
• Not specify a DB subnet group. These Read
Replicas will be created outside of any VPC.
--tag-key
-tk
--tag-value
-tv
The name of a tag to add for the new Read
Replica.
No
The value of the tag to add for the new Read
Replica.
No
Output
The command returns a table that contains the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• DBInstanceID—The user-supplied DB instance identifier
• Created—The data and time the instance was created, in 24-hour UTC
• Class—The compute and memory capacity of the instance
• CopyTagsToSnapshot—Specifies whether tags are copied from the DB instance to snapshots of the DB
instance.
API Version 2014-10-31
53
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Engine—Name of the database engine to be used for this DB instance
• Storage—Initially allocated storage size specified in gigabytes (GBs)
• Master Username—The master username for the DB instance
• Status—The current status of the DB instance. Valid values: available | backing-up | creating |
deleted | deleting | failed | modifying | rebooting | resetting-master-credentials | storage-full |
incompatible-parameters | incompatible-restore
• Publicly Accessible—Indicates the accessibility option of the instance. A value of true specifies an
Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A
value of false specifies an internal instance with a DNS name that resolves to a private IP address.
• Endpoint Address—Address of the DB instance
• Port—Port used to connect to the DB instance
• Iops—The provisioned IOPS allocated, expressed as I/O operations per second.
• AZ—The instance's Availability Zone
• Backup Retention—The number of days that automated backups are retained before deletion
• PendingBackupRetention—The backup retention period that will be applied at the next maintenance
window, or that is currently being applied if the --apply-immediately option was specified
• 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
• PendingStorage—The storage size 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
• PendingMulti-AZ—If true, indicates that the instance will be converted to run as a Multi-AZ
deployment; if false, the instance will be converted to run as a standard (Single-AZ) deployment.
• PendingVersion—The engine version of the pending database instance.
• DB Name—Name of the initial database created when the instance was created. 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 period during which automated backups are created. This column appears only
in the --show-long view
• Latest Restorable Time—The latest time to which a database can be restored using point-in-time
restore. This column appears only in the --show-long view.
• Multi-AZ—Indicates if this is a Multi-AZ DB instance.
• EngineVersion—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—The 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 parameter group. It can be either in-sync or pending-reboot
• Read Replica ID—The identifier of the source DB instance for which this DB instance acts as a Read
Replica
Examples
Create a Read Replica with Minimal Parameters
This example creates a Read Replica with the minimal set of parameters.
API Version 2014-10-31
54
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
PROMPT> rds-create-db-instance-read-replica SimCoProd01Replica01 -s SimcoProd01
DBINSTANCE simcoprod01replica01 db.m1.large
us-east-1b 0 n 5.1.50 simcoprod01
SECGROUP default active
PARAMGRP default.mysql5.1 in-sync
mysql
10
master
creating
Create a Read Replica and Specify an Availability Zone
This example creates a Read Replica, specifying an availability zone.
PROMPT> rds-create-db-instance-read-replica SimCoProd01Replica02 -s SimCoProd01-z useast-1a
DBINSTANCE simcoprod01replica02 db.m1.large
us-east-1a 0 n 5.1.50 simcoprod01
SECGROUP default active
PARAMGRP default.mysql5.1 in-sync
mysql
10
master
creating
Related Operations
• rds-create-db-instance (p. 31)
• rds-describe-db-instances (p. 81)
• rds-modify-db-instance (p. 120)
• rds-delete-db-instance (p. 69)
rds-create-db-parameter-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used
by the DB instance. To provide custom values for any of the parameters, you must modify the group
after creating it using rds-modify-db-parameter-group (p. 134). Once you've created a DB parameter
group, you need to associate it with your DB instance using rds-modify-db-instance (p. 120). When you
API Version 2014-10-31
55
Amazon Relational Database Service
Command Line Interface Reference
Syntax
associate a new DB parameter group with a running DB instance, you need to reboot the DB instance for
the new DB parameter group and associated settings to take effect.
Important
After you create a DB parameter group, you should wait at least 5 minutes before creating
your first DB instance that uses that DB parameter group as the default parameter group. This
allows Amazon RDS to fully complete the create action before the parameter group is used as
the default for a new DB instance. This is especially important for parameters that are critical
when creating the default database for a DB instance, such as the character set for the default
database defined by the character_set_database parameter. You can use the Parameter
Groups option of the Amazon RDS console or the rds-describe-db-parameters (p. 88)
command to verify that your DB parameter group has been created or modified.
Syntax
rds-create-db-parameter-group db-parameter-group-name
-d (--description) value
-f (--db-parameter-group-family) value
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
--db-parameter-groupname value
The name for the DB parameter group.
Yes
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-create-dbparameter-group my-db-parameter-group-name.
Type: String
Default: None
Constraints: Is non-preserving and case-insensitive.
Must contain visible characters only. Must be 1 to 63
alphanumeric characters or hyphens. Must not be
"Default".
Example: --db-parameter-group-name
mydbparametergroup
-d value
The description for the DB parameter group.
--description value
Type: String
Default: None
Constraints: Must not exceed 255 characters.
Example: -d "This is my parameter group"
API Version 2014-10-31
56
Yes
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-f value
The DB parameter group family. A DB parameter
group can be associated with one and only one DB
parameter group family, and can be applied only to
a DB instance running a database engine compatible
with that DB parameter group family.
Yes
--db-parameter-groupfamily value
Type: String
Default: None
Example: -f MySQL5.1
--tag-key
-tk
--tag-value
-tv
The name of a tag to add for the new DB parameter
group.
No
The value of the tag to add for the new DB parameter
group.
No
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group Name—The user-supplied DB parameter group name
• Parameter Group Family—Parameter group family to which this group applies.
• Description—The description of the DB parameter group
Examples
Create a DB parameter group
This example creates a new DB parameter group.
PROMPT> rds-create-db-parameter-group mydbparametergroup -f mysql5.1 -d "My first DB
parameter group"
DBPARAMETERGROUP
DBPARAMETERGROUP
Group Name
mydbparametergroup
Parameter Group Family
mysql5.1
Related Operations
• rds-copy-db-parameter-group (p. 26)
API Version 2014-10-31
57
Description
My first DB parameter group
Amazon Relational Database Service
Command Line Interface Reference
rds-create-db-security-group
• rds-delete-db-parameter-group (p. 73)
• rds-modify-db-instance (p. 120)
• rds-modify-db-parameter-group (p. 134)
• rds-describe-db-parameter-groups (p. 86)
rds-create-db-security-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a new DB security group.
Syntax
rds-create-db-security-group db-security-group-name
-d (--db-security-group-description) value
-v (--ec2-vpc-id)value
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
--db-security-groupname value
The name for the DB security group. This value is
store as a lowercase string.
Yes
-n value
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-create-dbsecurity-group my-db-security-group-name.
Type: String
Default: None
Constraints: Must contain visible characters only;
cannot contain spaces. Must contain no more than
API Version 2014-10-31
58
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
255 alphanumeric characters or hyphens. Must not
begin with a number, and cannot be named "default."
Example: --db-security-group-name
mysecuritygroup
-d value
The description for the database security group.
--db-security-groupdescription value
Type: String
Yes
Default: None
Constraints: Must not exceed 255 characters.
Example: -d "This is my DB Security group"
--tag-key
-tk
--tag-value
-tv
The name of a tag to add for the new DB security
group.
No
The value of the tag to add for the new DB security
group.
No
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Name—DB security group name
• Description—DB security group description
• VpcId—Identifier of the VPC to which this DB security group belongs
• EC2 Group Name—EC2 security group name
• EC2 Owner ID—EC2 security group owner
• Status—Status of authorization. Valid values: authorizing | authorized | revoking
• IP Range—CIDR range for the security group
Examples
Create a Database Security Group
This example creates a new database security group.
PROMPT> rds-create-db-security-group --db-security-group-name mygroup --db-security-groupdescription "My Security Group"
API Version 2014-10-31
59
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
Related Operations
• rds-delete-db-security-group (p. 74)
• rds-authorize-db-security-group-ingress (p. 20)
• rds-describe-db-security-groups (p. 90)
rds-create-db-snapshot
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a recoverable DB snapshot of all data associated with a DB instance.
Note
This operation is not supported for Read Replica DB instances.
Syntax
rds-create-db-snapshot db-instance-identifier
-s (--db-snapshot-identifier) value
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
--db-instanceidentifier value
DB instance identifier. This is the unique key that
identifies a DB instance. This parameter is stored as a
lowercase string.
Yes
-i value
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-create-dbsnapshot my-db-instance-identifier.
Type: String
Default: None
Constraints: Must contain 1 to 63 alphanumeric
characters or hyphens. First character must be a
API Version 2014-10-31
60
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
letter. Cannot end with a hyphen or contain two
consecutive hyphens.
Example: --db-instance-identifier mydbinstance
--db-snapshotidentifier value
-s value
The identifier for the DB snapshot.
Yes
Type: String
Default: None
Constraints: Cannot be null, empty, or blank. Cannot
be a word reserved by the database engine. Must
contain 1 to 255 alphanumeric characters or hyphens.
First character must be a letter. Cannot end with a
hyphen or contain two consecutive hyphens.
Example: -s my-snapshot-id
--tag-key
The name of a tag to add for the new DB snapshot.
No
The value of the tag to add for the new DB snapshot.
No
-tk
--tag-value
-tv
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• DBSnapshotId—Name of the DB snapshot
• Snapshot Created—The time (in 24 hour UTC) when the DB snapshot was taken
• DBInstanceId—User-supplied database identifier; this is the unique key that identifies a DB instance
• Instance Created—The date and time when the DB instance was created
• Engine—The name and version of the database engine used
• Storage—The size of the DB snapshot's allocated storage (GB)
• Storage Type—The storage type of the DB snapshot
• Encrypted—Indicates whether the DB snapshot is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB snapshot
• Status—Status of the DB snapshot. Valid values: creating | available | deleting
• AZ—The original Availability Zone of the database from which the DB snapshot was taken. This
column appears only in the --show-long view
• Iops—The provisioned IOPS allocated, expressed as I/O operations per second
• Port—The original port of the database from which the DB snapshot was taken. This column appears
only with the --show-long-view command option
API Version 2014-10-31
61
Amazon Relational Database Service
Command Line Interface Reference
Examples
Examples
Create a Database Snapshot
This example creates a new DB snapshot.
PROMPT> rds-create-db-snapshot -i mydbinstance -s mytestsnapshot
Related Operations
• rds-delete-db-snapshot (p. 75)
• rds-describe-db-snapshots (p. 91)
• rds-restore-db-instance-from-db-snapshot (p. 155)
rds-create-db-subnet-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a new DB subnet group.
Syntax
rds-create-db-subnet-group db-subnet-group-name
-d (--db-subnet-group-description) value,
[-s (--db-subnet-list) value, [value, ...]
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
--db-subnet-group-name
value
The name for the DB subnet group. This value is
stored as a lowercase string.
Yes
API Version 2014-10-31
62
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
-n value
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-create-dbsubnet-group my-db-subnet-group-name.
Required
Type: String
Default: None
Constraints: Must contain visible characters only.
Must contain no more than 255 alphanumeric
characters, periods, underscores, or hyphens. Must
not be default.
Example: --db-subnet-group-name mysubnetgroup
--db-subnet-groupdescription value
-d value
The description for the database subnet group.
Yes
Type: String
Default: None
Constraints: Must not exceed 255 characters.
Example: -d "This is my DB Subnet group"
--db-subnet-list value,
value, ...
-s value, value, ...
A list of one or more subnets to add to this DB subnet
group. DB subnet groups must contain at least one
subnet in at least two AZs in the region.
No
Type: String
Default: None
Constraints: Must be existing subnets.
Example: -s subnet1, subnet2
--tag-key
-tk
--tag-value
-tv
The name of a tag to add for the new DB subnet
group.
No
The value of the tag to add for the new DB subnet
group.
No
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Name—DB subnet group name
API Version 2014-10-31
63
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Description—DB subnet group description
• Status—The status of the DB subnet group.
• Subnet Identifier— Subnet Group identifier
• Subnet Availability Zone— The Subnet Availability Zone
• Status—The status of the subnet
Examples
Create a Database Security Group
This example creates a new database security group.
PROMPT> rds-create-db-subnet-group --db-subnet-group-name mygroup --db-subnet-groupdescription "My Subnet Group" --db-subnet-list subnet1, subnet2, subnet3
Related Operations
• rds-delete-db-subnet-group (p. 77)
• rds-modify-db-subnet-group (p. 136)
• rds-describe-db-subnet-groups (p. 96)
rds-create-event-subscription
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates an Amazon RDS event notification subscription. This action requires a topic ARN created by
either the RDS console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with
Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in
the Amazon SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of Amazon RDS
sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for
events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds =
mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier
= myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify
a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source
API Version 2014-10-31
64
Amazon Relational Database Service
Command Line Interface Reference
Syntax
type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you
will be notified of events generated from all Amazon RDS sources belonging to your customer account.
Syntax
rds-create-event-subscription subscription-name
-t (--sns-topic-arn) value
[--event-categories value ]
[--source-ids value ]
[-s (--source-type) value ]
[--disable value ]
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
--subscription-name value
The name of the subscription.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdscreate-event-subscription my-subscriptionname.
Type: String
Constraints: The name must be less than 255
characters.
Example: --subscription-name mysubscription1
--sns-topic-arn value
-t value
--event-categories value
The Amazon Resource Name (ARN) of the Amazon
SNS topic created for event notification. The ARN
is created by Amazon SNS when you create a topic
and subscribe to it.
Yes
A list of event categories for a SourceType that
you want to subscribe to.You can see a list of the
categories for a given SourceType in the Events
topic in the Amazon Relational Database Service
User Guide.
No
Type: String list
--source-ids value
A list of identifiers of the event sources for which
events will be returned. If not specified, then all
sources are included in the response. An identifier
must begin with a letter and must contain only
API Version 2014-10-31
65
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
ASCII letters, digits, and hyphens; it cannot
end with a hyphen or contain two consecutive
hyphens.
Type: String list
Constraints:
If SourceIds are supplied, SourceType must also
be provided.
If the source type is a DB instance, then a DB
instance identifier must be supplied.
If the source type is a DB security group, a DB
security group name must be supplied.
If the source type is a DB parameter group, a DB
parameter group name must be supplied.
If the source type is a DB snapshot, a DB snapshot
identifier must be supplied.
--source-type value
-s value
The type of source that will be generating the
events. For example, if you want to be notified of
events generated by a DB instance, you would set
this parameter to db-instance. if this value is not
specified, all events are returned.
No
Valid values: db-instance | db-parameter-group |
db-security-group | db-snapshot
Type: String
--disable value
A Boolean value; set to false to activate the
subscription. You can set this value to true if you
want to create the subscription but not activate it.
The default is true.
No
Type: Boolean
--tag-key
-tk
--tag-value
-tv
The name of a tag to add for the new event
subscription.
No
The value of the tag to add for the new event
subscription.
No
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
API Version 2014-10-31
66
Amazon Relational Database Service
Command Line Interface Reference
Examples
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• CustSubscriptionId—the Id of the event subscription
• CustomerAwsId—the AWS customer account associated with the Amazon RDS event notification
subscription
• Enabled—a Boolean value indicating if the subscription is enabled. True indicates the subscription is
enabled
• EventCategoriesList—a list of event categories for the Amazon RDS event notification subscription
• SnsTopicArn—the Amazon SNS topic's ARN for the Amazon RDS event notification subscription
• SourceIdsList—a list of source Ids for the Amazon RDS event notification subscription
• SourceType—the source type for the Amazon RDS event notification subscription
• Status—the status of the Amazon RDS event notification subscription. Can be one of the following:
creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that Amazon RDS no longer has permission to post to the
Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the
subscription was created.
• SubscriptionCreationTime—the time the RDS event notification subscription was created
Examples
Creating an event subscription
This example creates a subscription called MySubscription1 that receives event notifications whenever a
Failover category event occurs for the DB instance named MyDBInstance1. value of
PROMPT> rds-create-event-subscription MySubscription1
-t arn:aws:sns:us-west-2:803981917763:MyTopic --SourceIds MyDBInstance1 --SourceType
db-instance --EventCategories Failover
Creating an event subscription with multiple source Ids and
event categories
This example creates a subscription called MySubscription2 that receives event notifications from the
Failure and Configuration Change event categories for a DB instance and a DB security group.
PROMPT> rds-create-event-subscription MySubscription2
-t arn:aws:sns:us-west-2:803981917763:MyTopic --SourceIds MyDBInstance1,
MySecurityGroup1 --SourceType db-instance, db-security-group
--EventCategories Failure, Configuration Change
Related Operations
• rds-add-source-identifier-to-subscription (p. 15)
• rds-remove-source-identifier-from-subscription (p. 150)
API Version 2014-10-31
67
Amazon Relational Database Service
Command Line Interface Reference
rds-create-option-group
• rds-modify-event-subscription (p. 138)
• rds-describe-event-subscriptions (p. 104)
rds-create-option-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates an option group.
Syntax
rds-create-option-group option-group-name
--engine-name value
--major-engine-version value
--description "value"
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
--option-group-name
value
Name of the option group to be created.
Yes
--engine-name
The name of the DB engine that the option
applies to, for example, oracle-ee.
Yes
--major-engine-version
The major version of the DB engine.
Yes
-v
Valid values: For a list of valid values, see the -engine-version parameter in the rds-create-dbinstance (p. 31)
-e
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdscreate-option-group my-option-group-name.
API Version 2014-10-31
68
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
--description
A brief description of the option group for display
purposes.
Yes
The name of a tag to add for the new option
group.
No
The value of the tag to add for the new option
group.
No
-d
--tag-key
-tk
--tag-value
-tv
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group name—The name of the option group.
• Engine—The name of the DB engine that the option group is associated with.
• Major engine version—The major version ID of the DB engine.
• Description—The description of the option group.
Example
This example creates an option group named TestOptionGroup, which is associated with the Oracle
Enterprise Edition DB engine.
PROMPT> rds-create-option-group TestOptionGroup --engine-name oracle-ee --major-engineversion 11.2 --description "Oracle Database Manager Database Control"
OPTIONGROUP testoptiongroup oracle-ee 11.2 Oracle Database Manager Database Control
Related Operations
• rds-copy-option-group (p. 28)
rds-delete-db-instance
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
API Version 2014-10-31
69
Amazon Relational Database Service
Command Line Interface Reference
Description
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Deletes a DB instance. Once started, the process cannot be stopped, and the DB instance will no longer
be accessible. When you delete a DB instance, all automated backups for that instance are deleted and
cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
When a DB instance is in a failure state with a status of "failed," "incompatible-restore," or "incompatiblenetwork," it can only be deleted when the skip-final-snapshot parameter is set to "true."
Syntax
rds-delete-db-instance db-instance-identifier
[-f (--force) ]
[--final-db-snapshot-identifier value ]
[--skip-final-snapshot ]
[General Options]
Options
Name
Description
Required
--db-instance-identifier value
DB instance identifier.
Yes
This parameter is the default parameter and
can be passed as the first value in the command
and without a parameter name, for example:
rds-delete-db-instance my-db-instanceidentifier.
--force value
-f value
--final-db-snapshot-identifier
value
Forces no confirmation prompt for the delete
operation.
No
Name for the final DB snapshot. This option is not
permitted if the --skip-final-snapshot option is
specified, and must be provided if --skip-finalsnapshot is not specified. Cannot be specified
when deleting a Read Replica.
No
Constraints: Must contain 1 to 255 alphanumeric
characters or hyphens. First character must be a
letter. Cannot end with a hyphen or contain two
consecutive hyphens.
--skip-final-snapshot
Specifies that no final DB snapshot should be
made of the DB instance before it is deleted. Must
API Version 2014-10-31
70
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
be set to true when deleting a Read Replica.This
parameter must not be specified if the --finaldb-snapshot parameter is provided.
When a DB instance is in a failure state with
a status of "failed," "incompatible-restore," or
"incompatible-network," it can only be deleted
when the skip-final-snapshot parameter is set to
"true."
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• 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 Amazon RDS instance
• Engine—Name of the database engine to be used for this DB instance
• Storage—Initially allocated storage size specified in GBs
• Storage Type—The type of storage specified
• Storage Encrypted—Indicates whether the DB instance is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB instance
• Resource Id—If Storage Encrypted is true, the region-unique, immutable identifier for the encrypted
DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB
instance is accessed.
• Master Username—The master username for the instance
• Status—Status of the DB snapshot. Valid values: creating | available | deleting
• Endpoint Address—Address of the DB instance
• Port—The original port of the database from which the DB snapshot was taken. This column appears
only with the --show-long-view command option
• AZ—The original Availability Zone of the database. This column appears only in the --show-long view
• 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
• PendingStorage—The storage size 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
• 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.
• DB Name—Name of the initial database created when the instance was created or the Oracle System
ID (SID) of the created DB instance (for the Oracle engine). This column appears only in the --showlong view
API Version 2014-10-31
71
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Maintenance Window—The period during which patching and instance modifications will be
performed. This column appears only in the --show-long view
• Name—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 parameter group. Valid values: in-sync | pending-reboot |
applying
Examples
Delete a Database Instance with No Final DB snapshot
This example deletes a DB instance, forcing data deletion so no final DB snapshot is created.
PROMPT>
rds-delete-db-instance databaseInstance1 --skip-finalsnapshot
Once you begin deleting this database, it will no longer be able to accept connections.
Are you sure you want to delete this database? [Ny]y
Delete a Database Instance, Allowing a Final DB snapshot
This example deletes a database, but specifies a final DB snapshot.
PROMPT> rds-delete-db-instance databaseInstance1 --final-db-snapshot-identifier
myfinalsnapshot
Once you begin deleting this database, it will no longer be able to accept connections.
Are you sure you want to delete this database? [Ny]y
Output Example with Column Headers
This example shows command output with column headers.
DBINSTANCE DBInstanceId Created
Class
Engine
Storage Master
Username Status
Endpoint Address
Port AZ
PendingClass
PendingCredentials
DBINSTANCE simcoprod01
2009-05-15 22:13:39.559 db.m1.large MySQL5.1 10GB
master
available
mydbinstance.kldusfasddog.us-east-1.rds.am...us-east-1c
SECGROUP Name
Status
SECGROUP Default authorized
PARAMGRP Group Name
Apply Status
PARAMGRP mydbconfig
in-sync
Related Operations
• rds-create-db-instance (p. 31)
API Version 2014-10-31
72
Amazon Relational Database Service
Command Line Interface Reference
rds-delete-db-parameter-group
• rds-describe-db-instances (p. 81)
• rds-delete-db-instance (p. 69)
rds-delete-db-parameter-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Deletes a DB parameter group. The specified DB parameter group cannot be associated with any DB
instances.
Syntax
rds-delete-db-parameter-group db-parameter-group-name
[General Options]
Options
Name
Description
Required
--db-parameter-groupname value
DB parameter group identifier.
Yes
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-delete-dbparameter-group my-db-parameter-group-name.
Constraints: Must contain 1 to 255 alphanumeric
characters or hyphens. First character must be a
letter. Cannot end with a hyphen or contain two
consecutive hyphens.
--force value
-f value
If specified, forces the deletion to proceed without a
confirmation prompt.
Examples
Delete a DB parameter group
This example deletes a DB parameter group.
API Version 2014-10-31
73
No
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
PROMPT> rds-delete-db-parameter-group mydbparametergroup1
Related Operations
• rds-create-db-parameter-group (p. 55)
• rds-describe-db-parameter-groups (p. 86)
• rds-modify-db-parameter-group (p. 134)
rds-delete-db-security-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Deletes a database security group. The specified security group cannot be in use by any DB instances.
Syntax
rds-delete-db-security-group db-security-group-name
[General Options]
Options
Name
Description
Required
--db-security-groupname value
The DB security group identifier.
Yes
-n value
--force value
-f value
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-delete-dbsecurity-group my-db-security-group-name.
If specified, forces the deletion to proceed without a
confirmation prompt.
Examples
Delete a DB Security Group
This example deletes a database security group.
API Version 2014-10-31
74
No
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
PROMPT>
rds-delete-db-security-group
mysecuritygroup
Once you begin deleting this security group, it will no longer be available
for setting access permissions on your DB instances.
Are you sure you want to delete this security group [Ny]
Related Operations
• rds-create-db-security-group (p. 58)
• rds-describe-db-security-groups (p. 90)
rds-delete-db-snapshot
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
Syntax
rds-delete-db-snapshot db-snapshot-identifier
[General Options]
Options
Name
Description
Required
--db-snapshotidentifier value
DB snapshot identifier.
Yes
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-delete-dbsnapshot my-db-snapshot-identifier.
Constraints: Must contain 1 to 63 alphanumeric
characters or hyphens. First character must be a
letter. Cannot end with a hyphen or contain two
consecutive hyphens.
--force value
-f value
If specified, forces the deletion to proceed without a
confirmation prompt.
API Version 2014-10-31
75
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• DBSnapshotId—Name of the DB snapshot
• Snapshot Created—The time (UTC) when the DB snapshot was taken
• DBInstanceId—User-supplied database identifier; this is the unique key that identifies a DB instance
• Instance Created—The date and time when the DB instance was created
• Engine—The name and version of the database used
• Storage—The size of the DB snapshot's allocated storage (GB)
• Storage Type—The storage type of the DB snapshot
• Encrypted—Indicates whether the DB snapshot is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB snapshot
• Status—Status of the DB snapshot. Valid values: creating | available
• Master Username—The login name of the database's master user
• AZ—The original Availability Zone of the database from which the DB snapshot was taken. This
column appears only in the --show-long view.
• Port—The original port of the database from which the DB snapshot was taken. This column appears
only in the --show-long view.
Examples
Delete a Database Snapshot
This example deletes a DB snapshot.
PROMPT> rds-delete-db-snapshot mysnapshot
Once you begin deleting this snapshot, it will no longer be available for db
instance restoration.
Are you sure you want to delete this snapshot [Ny]
Output Example
This example shows detailed output with column headers.
DBSNAPSHOT
Engine
DBSnapshotId
Snapshot Created
Storage Status
Master Username
API Version 2014-10-31
76
DBInstanceId
Instance Created
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
DBSNAPSHOT mysnapshot
2009-08-2721:56:55.034
2009-09-03 19:08:13.710 mydbinstance
MySQL5.1 10GB
deleted sa
Related Operations
• rds-create-db-snapshot (p. 60)
• rds-describe-db-snapshots (p. 91)
rds-delete-db-subnet-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Deletes a db subnet group. The specified subnet group cannot be in use.
Syntax
rds-delete-db-subnet-group db-subnet-group-name
[General Options]
Options
Name
Description
Required
--db-subnet-group-name
value
DB subnet group identifier.
Yes
-n value
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-delete-dbsubnet-group my-db-subnet-group-name.
Constraints: Must contain 1 to 255 alphanumeric
characters or hyphens. First character must be a
letter. Cannot end with a hyphen or contain two
consecutive hyphens.
--force value
-f value
If specified, forces the deletion to proceed without a
confirmation prompt.
API Version 2014-10-31
77
No
Amazon Relational Database Service
Command Line Interface Reference
Examples
Examples
Delete a DB Security Group
This example deletes a database security group.
PROMPT>
rds-delete-db-security-group mysecuritygroup
be available
Once you begin deleting this security group, it will no longer
for setting access permissions on your DB instances.
Are you sure you want to delete this security group [Ny]
Related Operations
• rds-create-db-subnet-group (p. 62)
• rds-modify-db-subnet-group (p. 136)
• rds-describe-db-subnet-groups (p. 96)
rds-delete-event-subscription
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Deletes an Amazon RDS event notification subscription. Note that if you want to temporarily turn off a
subscription instead of deleting it, you can use the rds-modify-event-subscription command and set the
Enabled parameter to false.
Syntax
rds-delete-event-subscription subscription-name
[General Options]
Options
Name
Description
Required
--subscription-name value
The name of the subscription.
Yes
API Version 2014-10-31
78
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsdelete-event-subscription my-subscriptionname.
Type: String
Constraints: The name must be less than 255
characters.
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• CustSubscriptionId—the Id of the event subscription
• CustomerAwsId—the AWS customer account associated with the Amazon RDS event notification
subscription
• Enabled—a Boolean value indicating if the subscription is enabled. True indicates the subscription is
enabled
• EventCategoriesList—a list of event categories for the Amazon RDS event notification subscription
• SnsTopicArn—the Amazon SNS topic's ARN for the Amazon RDS event notification subscription
• SourceIdsList—a list of source Ids for the RDS event notification subscription
• SourceType—the source type for the Amazon RDS event notification subscription
• Status—the status of the Amazon RDS event notification subscription. Can be one of the following:
creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the Amazon SNS
topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was
created.
• SubscriptionCreationTime—the time the Amazon RDS event notification subscription was created
Examples
Deleting an event subscription
This example deletes a subscription called MySubscription1.
PROMPT> rds-delete-event-subscription MySubscription1
API Version 2014-10-31
79
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
Related Operations
• rds-add-source-identifier-to-subscription (p. 15)
• rds-remove-source-identifier-from-subscription (p. 150)
• rds-modify-event-subscription (p. 138)
• rds-describe-event-subscriptions (p. 104)
rds-delete-option-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Deletes an option group. You can delete an option group only if it is not associated with any DB instance.
Syntax
rds-delete-option-group option-group-name
[--force]
[General Options]
Options
Name
Description
Required
--option-group-name value
Name of the option group to be deleted.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsdelete-option-group my-option-group-name.
--force value
-f value
If specified, forces the deletion to proceed without No
a confirmation prompt.
Example
This example deletes an option group named TestOptionGroup.
PROMPT> rds-delete-option-group TestOptionGroup
Once you delete this option group, it will no longer be available for use.
API Version 2014-10-31
80
Amazon Relational Database Service
Command Line Interface Reference
rds-describe-certificates
Are you sure you want to delete this option group [Ny]
rds-describe-certificates
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns a set of CA certificates associated with this account. If you pass in a certificate identifier, the
command returns information only about that certificate. Otherwise it will return information for all the
associated certificates, up to the value of --max-records.
Syntax
rds-describe-certificates certificate-identifier [General Options]
Options
Name
Description
Required
--certificate-identifier value
User-supplied certificate identifier, the unique key
that identifies a certificate. The identifier must be
1 to 63 alphanumeric characters or hyphens, is
case-insensitive, and is not case-preserving.
No
-cert value
Output
The command returns a table that contains the following information:
• CertificateIdentifier—User-supplied CA certificate identifier; this is the unique key that identifies a
certificate
• CertificateType—Indicates the type of certificate.
• Thumbprint—The thumbprint of the certificate.
• ValidFrom—Specifies the first day the certificate is valid.
• ValidTill—Specifies the last day the certificate is valid.
rds-describe-db-instances
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
API Version 2014-10-31
81
Amazon Relational Database Service
Command Line Interface Reference
Description
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about all DB instances for an account if no DB instance identifier is specified, 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 [db-instance-identifier]
[General Options]
Options
Name
Description
Required
--db-instanceidentifier value
DB instance identifier. This is the unique key that
identifies an DB instance. Stored as a lowercase
string.
No
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-describe-dbinstances my-db-instance-identifier.
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
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
API Version 2014-10-31
82
Amazon Relational Database Service
Command Line Interface Reference
Output
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• 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
• Storage Type—The type of storage specified
• Storage Encrypted—Indicates whether the DB instance is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB instance
• Resource Id—If Storage Encrypted is true, the region-unique, immutable identifier for the encrypted
DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB
instance is accessed.
• 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
• Endpoint Address—Address of the DB instance
• Port—Port used to connect to the DB instance
• AZ—The instance's Availability Zone
• SecondaryAZ—When the DB instance has multi-AZ support, this value is the secondary AZ.
• 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 or the Oracle System
ID (SID) of the created DB instance (for the Oracle engine). This column appears only in the --showlong 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.
• Iops—The provisioned storage IOPS, expressed as I/O operations per second.
• 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.
• Replication State—The status of the Read Replica replication.
API Version 2014-10-31
83
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Change Date—The date of the last replication state change for the Read Replica.
• CACertificateIdentifier—Specifies the name of the CA certificate associated with the DB instance.
• PendingCACertificateIdentifier—Specifies the name of the CA certificate to be associated with the DB
instance.
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
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
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
50
10
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
Related Operations
• rds-create-db-instance (p. 31)
• rds-delete-db-instance (p. 69)
API Version 2014-10-31
84
Amazon Relational Database Service
Command Line Interface Reference
rds-describe-db-log-files
• rds-modify-db-instance (p. 120)
rds-describe-db-log-files
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Displays a list of log files available for an DB instance; the list can be filtered by the optional parameters.
The DescribeDBLogFiles API action ignores the MaxRecords parameter when listing Oracle log files and
returns up to 1000 records.
Syntax
rds-describe-db-log-files db-instance-identifier
[--filename-contains value ]
[--file-last-written value ]
[--file-size value ]
[General Options]
Options
Name
Description
Required
--db-instanceidentifier value
DB instance identifier. This is the unique key that
identifies an DB instance. Stored as a lowercase
string.
Yes
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-describe-dblog-files my-db-instance-identifier.
Type: String
--filename-contains
Returns the available log files for log file names that
contain the specified string.
No
Type: String
--file-last-written
Returns the available log files for files written since
the specified date. The date must be specified
as a number (Long) format using POSIX (Epoch)
API Version 2014-10-31
85
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
timestamp format, including milliseconds. Example:
1414974889000.
Type: Long
--file-size
Returns the available log files for files larger than the
specified size (in bytes).
No
Type: Integer
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• FileName—The log file name available.
• LastWritten—The date and time that the log file was last written.
• Size—The size of the log file (in bytes).
Examples
Get a List of All Log Files for a DB instance
This example returns a list of all log files for a DB instance named mysql-prod-db1.
PROMPT> rds-describe-db-log-files mysql-prod-db1
Related Operations
• rds-watch-db-logfile (p. 175)
rds-describe-db-parameter-groups
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-file-
API Version 2014-10-31
86
Amazon Relational Database Service
Command Line Interface Reference
Description
portion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about all DB parameter groups for an account if no database parameter group name
is supplied, or displays information about a specific named DB parameter group.
Syntax
rds-describe-db-parameter-groups [db-parameter-group-name]
[General Options]
Options
Name
Description
Required
--db-parameter-groupname value
DB parameter group name.
No
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-describe-dbparameter-groups my-db-parameter-group-name.
Type: String
Default: None
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group Name—User-supplied DB parameter group name.
• Parameter Group Family—Parameter group family to which this group applies.
• Description—Description of the DB parameter group.
Examples
Get a Description of All DB parameter groups
This example returns a description of all DB parameter groups for the account, with column headers.
PROMPT> rds-describe-db-parameter-groups
API Version 2014-10-31
87
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
DBPARAMETERGROUP
Group Name
DBPARAMETERGROUP default.MySQL5.1
database configuration for MySQL5.1
Parameter Group Family
Description
MySQL5.1
The default
Related Operations
• rds-create-db-parameter-group (p. 55)
• rds-delete-db-parameter-group (p. 73)
• rds-modify-db-parameter-group (p. 134)
rds-describe-db-parameters
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about parameters that are part of a parameter group. You can optionally request
only parameters from a specific source.
Syntax
rds-describe-db-parameters db-parameter-group-name
[--source value ]
[General Options]
Options
Name
Description
Required
--db-parameter-groupname
DB parameter group name.
Yes
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-describe-dbparameters my-db-parameter-group-name.
Type: String
Default: None
API Version 2014-10-31
88
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
--source value
Specifies which parameter types to return.
No
Type: String
Default: None
Valid values: user | system | engine-default
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Parameter Name—The name of the parameter.
• Parameter Value—The current value of the parameter.
• Description—A short description of the parameter.
• Source—Whether this parameter was set by the database engine, Amazon RDS (system), or the user.
Valid values: user | system | engine-default
• Data Type—The data type of the parameter.
• Apply Type—The type of parameter: Can be either static or dynamic.
• Is Modifiable—Indicates whether a given parameter is modifiable or not.
• Allowed Values—The allowed values for this parameter. This column appears only in the --show-long
view.
• Minimum Version—The earliest engine version to which the parameter can apply.
Examples
Retrieve the Parameters for a Specified DB parameter group
This example retrieves the parameters for the named parameter group, showing column headers on the
output.
PROMPT> rds-describe-db-parameters mydbparamgrp --headers
CONFIGPARAMETERS Parameter Name
Source
Apply Type
CONFIGPARAMETERS max_allowed_packet
can ... user
dynamic
CONFIGPARAMETERS log-error
error... engine-default static
Parameter Value
Description
Is Modifiable
2M
The largest possible packet that
true
/rdsdblog/error/m...specify where mysqld writes the
false
Related Operations
• rds-create-db-parameter-group (p. 55)
API Version 2014-10-31
89
Amazon Relational Database Service
Command Line Interface Reference
rds-describe-db-security-groups
• rds-describe-db-parameter-groups (p. 86)
• rds-delete-db-parameter-group (p. 73)
rds-describe-db-security-groups
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about all database security groups for an account if no database security group
name is supplied, or displays information about a specific named database security group.
Syntax
rds-describe-db-security-groups [db-security-group-name]
[General Options]
Options
Name
Description
Required
--db-security-groupname
Database security group name.
No
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-describe-dbsecurity-groups my-db-security-group-name.
Type: String
Default: None
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Name—Security group name
API Version 2014-10-31
90
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Description—Description of the database security group
• Amazon EC2 Group Name—EC2 security group name
• Amazon EC2 Owner Id—EC2 security group owner
• Status—Status of security group authorization. Valid values: adding | active | removing
• IP Range—the CIDR IP range allowed access to the security group
• Status—Status of authorization for the IP Range. Valid values: authorizing | authorized | revoking
Examples
Get a Description of All Security Groups
This example returns a description of all database security groups for the account, with column headers.
PROMPT> rds-describe-db-security-groups -H
SECGROUP Name
Description
SECGROUP Default Default
EC2-SECGROUP EC2 Group Name EC2 Owner Id
EC2-SECGROUP mytestgroup
210987654321
IP-RANGE IP Range
Status
IP-RANGE 12.23.34.45/30
authorized
IP-RANGE 1.2.3.4/32
authorized
Status
authorized
Related Operations
• rds-create-db-security-group (p. 58)
• rds-delete-db-security-group (p. 74)
• rds-authorize-db-security-group-ingress (p. 20)
• rds-revoke-db-security-group-ingress (p. 172)
rds-describe-db-snapshots
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about the DB snapshots for this account. If you pass in a db-instance-identifier,
it will return information only about DB snapshots taken for that instance. If you pass in a db-snapshotidentifier, it will return information only about the specified DB snapshot. If you omit both dbinstance-identifier and db-snapshot-identifier, it will return all snapshot information for all
API Version 2014-10-31
91
Amazon Relational Database Service
Command Line Interface Reference
Syntax
instances, up to max-records. Passing both db-instance-identifier and db-snapshot-identifier will
result in an error.
Syntax
rds-describe-db-snapshots
[-i (--db-instance-identifier)value]
[-s (--db-snapshot-identifier) value]
[-t (--snapshot-type) value]
[General Options]
Options
Name
Description
Required
--db-instanceidentifier value
The unique identifier for the DB instance.
No
-i value
Type: String
Default: None
Constraints: Must contain 1 to 63 alphanumeric
characters or hyphens. First character must be a
letter. Cannot end with a hyphen or contain two
consecutive hyphens.
Example: --db-instance-identifier mydbinstance
--db-snapshotidentifier value
The unique identifier for the DB snapshot. Stored as a
lowercase string.
-s value
Type: String
No
Default: None
Constraints: Must contain from 1 to 255
alphanumeric characters or hyphens. First character
must be a letter. Cannot end with a hyphen or contain
two consecutive hyphens.
Example: --db-snapshot-identifier m1233123-123
--snapshot-type value
-t value
The type of DB snapshot. Valid values include
"manual" and "automated." If no value is provided, all
snapshot types will be returned.
Type: String
Default: None
Example: --snapshot-type manual
Output
The command returns the following information:
API Version 2014-10-31
92
No
Amazon Relational Database Service
Command Line Interface Reference
Examples
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• DBSnapshotId—Name of the DB snapshot
• Snapshot Created—The time (UTC) when the DB snapshot was taken
• DBInstanceId—User-supplied database identifier; this is the unique key that identifies a DB instance
• Instance Created—The date and time when the DB instance was created
• Engine—The name of the database engine used
• Storage—The size of the DB snapshot's allocated storage (GB)
• Iops—The provisioned storage IOPS, expressed as I/O operations per second.
• Storage Type—The storage type of the DB snapshot
• Encrypted—Indicates whether the DB snapshot is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB snapshot
• Status—Status of the DB snapshot. Valid values: creating | available | deleting
• Master Username—The login name of the database's master user
• AZ—The original Availability Zone of the database from which the DB snapshot was taken. This
column appears only in the --show-long view
• Port—The original port of the database from which the DB snapshot was taken. This column appears
only in the --show-long view
• EngineVersion—Database engine version number.
Examples
Get a Description of All Database Snapshots
This example returns a description of all DB snapshots for the account, with column headers.
PROMPT> rds-describe-db-snapshots -H
DBSNAPSHOT DBSnapshotId Snapshot Created
DBInstanceId
Engine Storage Status
Master Username Version
DBSNAPSHOT mysnapshot1
mydbinstance
mysql
50
creating
sa
5.1.49
DBSNAPSHOT mysnapshot2
2010-08-05T00:15:51.815Z simcoprod01
mysql
60
available master
5.1.47
Related Operations
• rds-create-db-snapshot (p. 60)
• rds-delete-db-snapshot (p. 75)
• rds-restore-db-instance-from-db-snapshot (p. 155)
API Version 2014-10-31
93
Instance Created
2010-08-04T23:27:36.420Z
2010-07-16T00:06:59.107Z
Amazon Relational Database Service
Command Line Interface Reference
rds-describe-db-engine-versions
rds-describe-db-engine-versions
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about available database engine versions.
Syntax
rds-describe-db-engine-versions [-d (--default-only) ]
[-e (--engine) value ]
[-f (--db-parameter-group-family) value ]
[-v (--engine-version) value ]
[-cs (--list-supported-character-sets) value ]
[General Options]
Options
Name
Description
Required
-f
DB parameter group family filter value.
No
--db-parameter-group-family
value
Type: String
Default: None
Example: -f mysql5.1
-d
--default-only
Indicates that only the default version of the
specified engine or engine and major version
combination is returned.
No
Type: Switch flag
Example: --default-only
-e
Database engine filter value.
--engine value
Type: String
Example: -e mysql
API Version 2014-10-31
94
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-v
The version number of the database engine.
No
--engine-version value
Type: String
Example: -v 5.1.42
-cs
--list-supported-character-sets
Generates a list of supported Oracle character
sets.
No
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Engine—name of the database engine.
• EngineVersion—database engine version number.
• Parameter Group Family—the version's parameter group family.
• EngineVersion—database engine version number.
• Engine Description—full name of the database engine.
• Engine Version Description—full version information of the database engine.
• Default Character Set—the default character set for the database engine.
Examples
Describing Engine Versions
This example returns descriptions for all available versions of all available database engines.
PROMPT> rds-describe-db-engine-versions
VERSION Engine
Version
Engine Version Description
VERSION mysql
5.1.42
Version 5.1.42
VERSION mysql
5.1.45
Version 5.1.45
VERSION mysql
5.1.47
Version 5.1.47
VERSION oracle-ee 11.2.0.2.v3
EE Oracle EE 11.2.0.2.v3
Parameter Group Family
Default Character Set
mysql5.1
Engine Description
mysql5.1
MySQL
mysql5.1
MySQL
oracle-ee-11.2
AL32UTF8
Oracle Database Server
API Version 2014-10-31
95
MySQL
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
Describing Engine Versions for a Specific Engine
This example describes all available versions of the MySQL database engine.
PROMPT> rds-describe-db-engine-versions --engine mysql --show-long --header
VERSION
VERSION
VERSION
VERSION
VERSION
VERSION
VERSION
VERSION
Engine
mysql
mysql
mysql
mysql
mysql
mysql
mysql
Version
5.1.42
5.1.45
5.1.47
5.1.48
5.1.49
5.1.50
5.5.8
Parameter Group Family
mysql5.1
mysql5.1
mysql5.1
mysql5.1
mysql5.1
mysql5.1
mysql5.5
Related Operations
• rds-modify-db-instance (p. 120)
• rds-create-db-parameter-group (p. 55)
rds-describe-db-subnet-groups
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about all DB subnet groups for an account if no DB subnet group name is supplied,
or displays information about a specific named DB Subnet group.
Syntax
rds-describe-db-subnet-groups [db-subnet-group-name]
[General Options]
Options
Name
Description
Required
--db-subnet-group-name
value
DB Subnet Group name.
No
API Version 2014-10-31
96
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-describe-dbsubnet-groups my-db-subnet-group-name.
Type: String
Default: None
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Name—The name of the DB subnet group that was modified.
• Description—The description of the DB subnet group that was modified.
• Status—The status of the DB subnet group that was modified.
• Subnet Identifier—The identifier of a contained subnet.
• Subnet Availability Zone—The Availability Zone of the contained subnet.
• Status—The status of the contained subnet.
Examples
Get a Description of All Security Groups
This example returns a description of all database security groups for the account, with column headers.
PROMPT> rds-describe-db-subnet-groups -H
SUBNETGROUP Name
Description
Status
SUBNETGROUP mygroup my group desc Active
SUBNET Subnet Identifier Subnet Availability Zone
SUBNET mytestgroup
us-east-1c
Related Operations
• rds-create-db-subnet-group (p. 62)
• rds-modify-db-subnet-group (p. 136)
• rds-delete-db-subnet-group (p. 77)
API Version 2014-10-31
97
Status
Active
Amazon Relational Database Service
Command Line Interface Reference
rds-describe-engine-default-parameters
rds-describe-engine-default-parameters
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns a description of the default parameters used for the DB parameter group family.
Syntax
rds-describe-engine-default-parameters db-parameter-group-family
[General Options]
Options
Name
Description
Required
--db-parameter-groupfamily value
Contains the name of the DB parameter group family
for which to list defaults.
Yes
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-describeengine-default-parameters my-db-parametergroup-family.
Type: String
Default: None
Output
The command returns a table containing the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Parameter Name—The name of the parameter.
• Parameter Value—Value of the parameter.
• Description—A short description of the parameter.
API Version 2014-10-31
98
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Source—Indicates the source of the parameter. System indicates the parameter source is the Amazon
RDS service; EngineDefault indicates the parameter source is the database engine; User indicates the
parameter source is the user.
• Apply Type—Indicates the type of parameter. Valid values: static | dynamic
• Is Modifiable—Indicates whether a given parameter can be modified.
• Minimum Version—The earliest engine version to which the parameter can apply.
Examples
Display Parameter Values for the Default DBParameterGroup
This example shows how to display the default DBParameterGroup parameter values for a specific DB
parameter group family and return the results displaying table headers.
PROMPT> rds-describe-engine-default-parameters MySQL5.1 --headers
Related Operations
• rds-describe-db-parameters (p. 88)
• rds-modify-db-parameter-group (p. 134)
• rds-reset-db-parameter-group (p. 153)
rds-describe-events
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about events related to your DB instances, DB security groups or DB parameter
groups.
Syntax
rds-describe-events [--duration value ]
[--start-time value ]
[--end-time value ]
[--source-identifier value ]
[--source-type value ]
API Version 2014-10-31
99
Amazon Relational Database Service
Command Line Interface Reference
Options
[-a (--event-categories) value ]
[General Options]
Options
Name
Description
Required
--duration value
The number of minutes for which to retrieve events.
No
Type: Integer
Default: 60
Example: Retrieve the last 90 minutes worth of
events:
--duration 90
--start-time value
The beginning of the time interval to retrieve events,
specified in ISO8601 format. For more information
about ISO 8601, go to the ISO8601 format Wikipedia
page.
No
Type: Date
Default: none
Example: --start-time 2009-03-31T10:00:00
--end-time value
The end of the time interval to retrieve events,
specified in ISO8601 format. For more information
about ISO 8601, go to the ISO8601 format Wikipedia
page.
No
Type: Date
Default: none
Example: --start-time 2009-03-31T12:00:00
--event-categories
value
A list of event categories that trigger notifications for
a event notification subscription.
-a value
Type: String list
--source-type value
Specifies the event source for which to retrieve
events.
No
No
Type: String
Valid values: db-instance, db-security-group, dbparameter-group, db-snapshot
Example: --source-type db-instance
--source-identifier
value
Used with the --source-type parameter to restrict
returned events to a specific named source.
Type: String
API Version 2014-10-31
100
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
Default: 60
Example: --source-type db-instance --sourceidentifier mydbinstance
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Source Type—Type of event source
• Date—Database event date/time, in UTC
• Source Id—Identifier of the event source
• Category—Indicates the event category.
• Message—Event description
Examples
Describe All Events
This example returns all events with column headers.
PROMPT> rds-describe-events --headers
Source Type
db-instance
deleted
db-instance
deleted
db-instance
created
db-instance
created
db-security-group
security group
db-security-group
mysourcegroup owned by
db-security-group
security group
db-instance
deleted
db-instance
deleted
db-instance
deleted
db-instance
deleted
Date
2009-03-27 00:28:44
Source Id
test002
Message
Database instance test002
2009-03-27 00:30:08
test003
Database instance test003
2009-03-27 00:37:59
test001
Database instance test001
2009-03-27 00:39:05
test0010
Database instance test0010
2009-03-27 00:39:12
Default
Finished applying changes to
2009-03-27 00:40:22 Default
The security group
XXXXXX does not exist; revoking authorization
2009-03-27 00:44:44 Default
Finished applying changes to
2009-03-27 01:07:53
test0010
Database instance test0010
2009-03-27 01:09:09
test02
Database instance test02
2009-03-27 01:09:22
test004
Database instance test004
2009-03-27 01:09:58
test001
Database instance test001
API Version 2014-10-31
101
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
db-parameter-group 2009-03-27 00:39:12 myconfig
DBParameterGroup updated with
parameter max_binlog_size to 4096 with apply method Immediate
db-snapshot
2009-03-27 01:09:58 snapshotid
Deleted user snapshot:
snapshotid
Describe Events for a Specified Instance
This example returns only events for a specific DB instance.
PROMPT> rds-describe-events --source-type db-instance --source-identifier test001
Source Type
Date
Source Id
Message
db-instance
2009-03-27 00:37:59
test001
Database instance test001 created
db-instance
2009-03-27 01:09:58
test001
Database instance test001 deleted
Describe Events for a Specified Time Interval
This example returns only events for a specific time interval.
PROMPT> rds-describe-events --start-time 2009-03-20T00:00:00-08:00 --end-time
2009-03-20T23:59:59-08:00
Related Operations
• rds-describe-db-instances (p. 81)
• rds-describe-db-snapshots (p. 91)
• rds-describe-db-parameter-groups (p. 86)
• rds-describe-db-security-groups (p. 90)
rds-describe-event-categories
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can
see a list of the categories for a given SourceType in the Events topic in the Amazon Relational Database
Service User Guide.
API Version 2014-10-31
102
Amazon Relational Database Service
Command Line Interface Reference
Syntax
Syntax
rds-describe-event-categories
[-s (--source-type) value]
[General Options]
Options
Name
Description
Required
-s
The type of source that will be generating the
events. For example, if you want to be notified of
events generated by a DB instance, you would set
this parameter to db-instance. if this value is not
specified, all events are returned.
No
--source-type value
Valid values: db-instance | db-parameter-group |
db-security-group | db-snapshot
Type: String
Output
The command returns a list of event categories and their associated source type.
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• EventCategories—the event categories for the specified source type
• SourceType—the source type that the returned categories belong to
Examples
Describing the event categories available for RDS event
notification subscriptions
This example lists the event categories available for a DB instance source type.
PROMPT> rds-describe-event-categories --SourceType db-instance
Related Operations
• rds-add-source-identifier-to-subscription (p. 15)
API Version 2014-10-31
103
Amazon Relational Database Service
Command Line Interface Reference
rds-describe-event-subscriptions
• rds-create-event-subscription (p. 64)
• rds-modify-event-subscription (p. 138)
• rds-describe-event-subscriptions (p. 104)
rds-describe-event-subscriptions
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a subscription-name, lists the description for that subscription.
Syntax
rds-describe-event-subscriptions [subscription-name]
[General Options]
Options
Name
Description
Required
--subscription-name value
The name of the subscription.
No
This parameter is the default parameter and
can be passed as the first value in the command
and without a parameter name, for example:
rds-describe-event-subscriptions mysubscription-name.
Type: String
Constraints: The name must be less than 255
characters.
Example: --subscription-name mysubscription1
Output
The command returns a list of event subscriptions, each with the following information:
API Version 2014-10-31
104
Amazon Relational Database Service
Command Line Interface Reference
Examples
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• CustSubscriptionId—the Id of the event subscription
• CustomerAwsId—the AWS customer account associated with the Amazon RDS event notification
subscription
• Enabled—a Boolean value indicating if the subscription is enabled. True indicates the subscription is
enabled
• EventCategoriesList—a list of event categories for the Amazon RDS event notification subscription
• SnsTopicArn—the Amazon SNS topic's ARN for the Amazon RDS event notification subscription
• SourceIdsList—a list of source Ids for the Amazon RDS event notification subscription
• SourceType—the source type for the Amazon RDS event notification subscription
• Status—the status of the Amazon RDS event notification subscription. Can be one of the following:
creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that Amazon RDS no longer has permission to post to the
Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the
subscription was created.
• SubscriptionCreationTime—the time the Amazon RDS event notification subscription was created
• Marker—an optional pagination token provided by a previous request. If this parameter is specified,
the response includes only records beyond the marker, up to the value specified by MaxRecords.
Examples
Describing all event subscriptions
This example lists all subscriptions for the current AWS account.
PROMPT> rds-describe-event-subscriptions
Related Operations
• rds-add-source-identifier-to-subscription (p. 15)
• rds-remove-source-identifier-from-subscription (p. 150)
• rds-modify-event-subscription (p. 138)
• rds-create-event-subscription (p. 64)
rds-describe-option-group-options
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
API Version 2014-10-31
105
Amazon Relational Database Service
Command Line Interface Reference
Description
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Provides a list of options that can be added to option groups that are associated with the specified DB
engine.
Syntax
rds-describe-option-group-options
--engine-name value
[--major-engine-version value]
[General Options]
Options
Name
Description
Required
--engine-name
Name of the DB engine.
Yes
A filter that limits option groups described to
those associated with the specified major version
of the DB engine. Default is all versions.
No
-e
--major-engine-version
-v
Valid values: For a list of valid values, see the -engine-version parameter in the rds-create-dbinstance (p. 31)
Output
The command returns the following information for each available option:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Option—The name of the option.
• Engine—The name of the DB engine that the option requires.
• Minimum required engine version—The minimum major version ID of the DB engine that the option
requires.
• Port required—If y, the option requires a port.
• Default port—The default port that is used by the option.
• Description—A description of the option.
• Name—The name of the associated option group.
API Version 2014-10-31
106
Amazon Relational Database Service
Command Line Interface Reference
Example
• Status—The status of the option group membership. For example, the status could be in-sync,
applying, pending, or pending-maintenance.
Example
This example describes options that require Oracle Enterprise Edition:
PROMPT> rds-describe-option-group-options --engine-name oracle-ee
OPTION Option Name Engine
Port
Description
OPTION OEM
oracle-ee
Oracle Enterprise Manager
Minimum Required Engine Version Port Required
Default
11.2.0.2v3
1158
y
This example describes options that require Oracle Enterprise Edition 11.2:
PROMPT> rds-describe-option-group-options --engine-name oracle-ee
11.2
OPTION Option Name Engine
Port
Description
OPTION OEM
oracle-ee
Oracle Enterprise Manager
--major-engine-version
Minimum Required Engine Version Port Required
Default
11.2.0.2v3
1158
y
rds-describe-option-groups
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Provides information about a specific option group or about all option groups that are described with the
command. By default, all option groups are described.
Syntax
rds-describe-option-groups
[--option-group-name value]
[--engine-name value]
[--major-engine-version value]
[General Options]
API Version 2014-10-31
107
Amazon Relational Database Service
Command Line Interface Reference
Options
Options
Name
Description
Required
--option-group-name
Name of the option group to be described.
Default is all option groups.
No
A filter that limits option groups described to
those associated with the specified DB engine.
Default is all DB engines.
No
A filter that limits option groups described to
those associated with the specified major version
of the DB engine. Default is all major versions.
No
-g
--engine-name
-e
--major-engine-version
-v
Valid values: For a list of valid values, see the -engine-version parameter in the rds-create-dbinstance (p. 31)
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group name—The name of the option group.
• Engine—The name of the DB engine that the option group is associated with.
• Major engine version—The major version ID of the DB engine.
• Description—The description of the option group.
• VPC Specific—Indicates if both VPC and non-VPC instances can join this option group.
• VPC—Indicates if only instances in this VPC can join this option group.
• Name—The name of the option.
• Port—The port used by this option, if applicable.
• Description—The description of the option.
• Name—The security group name.
• Status—The status of authorization.
Example
This example describes all option groups that are associated with Oracle Enterprise Edition version 11.2:
PROMPT> rds-describe-option-groups --engine-name oracle-ee --major-engine-version 11.2
OPTIONGROUP default:oracle-ee-11-2
11.2
oracle-ee
11.2
API Version 2014-10-31
108
Default option group for oracle-ee
Amazon Relational Database Service
Command Line Interface Reference
rds-describe-orderable-db-instance-options
OPTIONGROUP testoptiongroup
Control
oracle-ee
11.2
Oracle Database Manager Database
rds-describe-orderable-db-instance-options
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about available orderable DB instance options.
Syntax
rds-describe-orderable-db-instance-options -e (--engine)
[-c (--db-instance-class) value ]
[-lm (--license-model) value ]
[-v (--engine-version) value ]
[--vpc ] value
[General Options]
Options
Name
Description
Required
-e value
The name of the engine to retrieve DB instance
options for.
Yes
--engine value
Type: String
Default: None
Example: -e mysql
-c
--db-instance-class value
The DB instance class filter value. Specify this
parameter to show only the available offerings
that match the specified DB instance class.
Type: String
Default: None
Example: -c db.m1.xlarge
API Version 2014-10-31
109
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-lm
The license model filter value. Specify this
parameter to show only the available offerings
that match the specified license model.
No
--license-model value
Type: String
Default: None
Example: --license-model bring-your-ownlicense
The engine version filter value. Specify this
parameter to show only the available offerings
matching the specified engine version.
-v
--engine-version value
No
Type: String
Default: None
Example: -v 5.1.50
The VPC filter value. Specify this parameter to
filter by VPC or non-VPC orderable database
instance options.
--vpc value
No
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Engine—the database engine name.
• Version—the database engine version.
• Class—the DB instance class.
• Storage Type—The type of storage specified.
• License—the license model.
• Multi-AZ—indicates if the configuration is Multi-AZ capable.
• ReadReplica—indicates if the configuration is Read Replica capable.
• Name—the name of the availability zone.
• Vpc—indicates if the configuration has VPC offered.
Examples
Describing All Orderable DB instance Options
This example returns descriptions of all orderable database instance options.
API Version 2014-10-31
110
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
PROMPT> rds-describe-orderable-db-instance-options
Describing Orderable DB instance Options for MySQL
This example returns descriptions of all orderable database instance options for the MySQL database
engine.
PROMPT> rds-describe-orderable-db-instance-options
--engine mysql
Related Operations
• rds-create-db-instance (p. 31)
rds-describe-pending-maintenance-actions
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns a list of resources (for example, DB Instances) that have at least one pending maintenance action
with details about the pending maintenance actions.
Syntax
rds-describe-pending-maintenance-actions [General Options]
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Action—The type of pending maintenance action that is available for the resource.
• OptInStatus—The type of opt-in request that has been received for the resource.
API Version 2014-10-31
111
Amazon Relational Database Service
Command Line Interface Reference
Example
• EffectiveApplyDate—The effective date when the pending maintenance action will be applied to
the resource. This date takes into account opt-in requests received from the rds-apply-pendingmaintenance-action (p. 19) command, the AutoApplyAfter date, and the ForcedApplyAt date.
This value is blank if an opt-in request has not been received and nothing has been specified as
AutoApplyAfter and ForcedApplyAt values.
• AutoApplyAfter—The date of the maintenance window when the action will be applied. The
maintenance action will be applied to the resource during its first maintenance window after this date.
If this date is specified, any next-maintenance opt-in requests are ignored.
• ForcedApplyAt—The date when the maintenance action will be automatically applied. The
maintenance action will be applied to the resource on this date regardless of the maintenance window
for the resource. If this date is specified, any immediate opt-in requests are ignored.
Example
The following example lists all of the pending maintenance actions in a region for the calling customer.
PROMPT> rds-describe-pending-maintenance-actions
The following example lists the pending maintenance actions for a DB instance named mysql-db that is
owned by customer 001234567890.
PROMPT> rds-describe-pending-maintenance-actions arn:aws:rds:uswest-2:001234567890:db:mysql-db
Related Operations
• rds-apply-pending-maintenance-action (p. 19)
rds-describe-reserved-db-instances
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about reserved DB instances for this account, or about a specified reserved DB
instance.
Syntax
rds-describe-reserved-db-instances
reserved-db-instance-id
API Version 2014-10-31
112
Amazon Relational Database Service
Command Line Interface Reference
Options
[-c (--db-instance-class) value ]
[-d (--duration) value ]
[-m (--multi-az) value ]
[-p (--product-description) value ]
[-o (--reserved-db-instances-offering-id) value ]
[-t (--offering-type) value ]
[General Options]
Options
Name
Description
Required
--reserved-db-instance-id value
Reserved DB instance identifier. Provide this
parameter to return only information about a
specific reserved DB instance.
No
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsdescribe-reserved-db-instances my-reserveddb-instance-id.
Type: String
Default: None
Example: --reserved-db-instance-id
myreserveddbinstance
-c
--db-instance-class value
DB instance class filter value. Specify this
parameter to show only reservations matching
the specified DB instances class.
No
Type: String
Default: None
Example: -c db.m1.xlarge
-d
--duration value
Duration filter value, specified in years. Specify
this parameter to show only reservations for this
duration.
No
Type: String
Default: None
Example: -d 3y
-m
--multi-az value
Multi-AZ filter value. Specify this parameter to
show only reservations matching the specified
multi-AZ parameter.
Type: Boolean
API Version 2014-10-31
113
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
Default: None
Example: -m true
-p
--product-description value
Product description filter value. Specify this
parameter to show only reservations matching
the specified product description.
No
Type: String
Default: None
Example: -p mysql
-o
--reserved-db-instancesoffering-id value
Offering identifier filter value. Specify this
parameter to show only reservations matching
the specified offering identifier.
No
Type: String
Default: None
Example: --reserved-db-instances-offering-id
SampleReservationID
-t
--offering-type value
If specified, only reserved DB instances for this
offering type will be shown.
No
Type: String
Default: None
Example: --offering-type "Partial Upfront"
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• ReservationId—the unique identifier for the reservation.
• OfferingID—the offering identifier (only appears when the --show-long parameter is specified).
• Class—the DB instance class for the reservation.
• Multi-AZ—indicates if the reservation applies to Multi-AZ deployments.
• Start Time—the time the reservation started
• Duration—the duration of the reservation in years
• Fixed Price—the fixed price charged for each DB instance in this reservation (only appears when the -show-long parameter is specified).
• Usage Price—the hourly price to run each reserved DB instance (only appears when the --show-long
parameter is specified).
API Version 2014-10-31
114
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Count—the number of database instances reserved.
• Status—the status of the reservation.
• Description—the database engine used by the reservation.
Examples
Describing Reserved Instances
This example returns descriptions of all of your database instance reservations
PROMPT> rds-describe-reserved-db-instances
Describing a Specific Reserved Instance
This example returns information about a specific reserved DB instance.
PROMPT> rds-describe-reserved-db-instances reservation1 --show-long --header
Related Operations
• rds-describe-reserved-db-instances-offerings (p. 115)
• rds-purchase-reserved-db-instances-offering (p. 143)
rds-describe-reserved-db-instances-offerings
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns information about available reserved DB instance offerings.
Syntax
rds-describe-reserved-db-instances-offerings reserved-db-instances-offering-id [--reserveddb-instances-offering-id value ]
[-c (--db-instance-class) value ]
[-d (--duration) value ]
API Version 2014-10-31
115
Amazon Relational Database Service
Command Line Interface Reference
Options
[-m (--multi-az) value ]
[-p (--product-description) value ]
[-t (--offering-type) ] value
[General Options]
Options
Name
Description
Required
reserved-db-instances-offeringid value
Offering identifier filter value. Specify this
parameter to show only the available offering
that matches the specified Reserved DB instances
Offering.
No
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsdescribe-reserved-db-instances-offerings
my-reserved-db-instances-offering-id.
Type: String
Default: None
Example: --reserved-db-instances-offering-id
438012d3-4052-4cc7-b2e3-8d3372e0e706
-c
--db-instance-class value
DB instance class filter value. Specify this
parameter to show only the available offerings
matching specified DB instances class.
No
Type: String
Default: None
Example: -c db.m1.xlarge
-d
--duration value
Duration filter value, specified in years. Specify
this parameter to show only the available
offerings for this duration.
No
Type: String
Default: None
Example: -d 3
-m
--multi-az value
Multi-AZ filter value. Specify this parameter
to show only available offerings matching the
specified Multi-AZ parameter.
Type: Boolean
Default: None
Example: -m true
API Version 2014-10-31
116
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-p
Product description filter value. Specify this
parameter to show only available offerings
matching the specified product description.
No
--product-description value
Type: Boolean
Default: None
Example: -p mysql
-t
--offering-type value
If specified, only offerings for this offering type
will be shown.
No
Type: String
Default: None
Example: --offering-type "Partial Upfront"
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• OfferingId—the unique identifier for the offering.
• Class—the DB instance class for the offering.
• Multi-AZ—indicates if the offering applies to Multi-AZ deployments.
• Duration—the length of the duration in years
• Fixed Price—the fixed price charged to reserve each DB instance.
• Usage Price—the hourly price to run each reserved DB instance.
• Description—the database engine used by the offering.
Examples
Describing Reserved Instances Offerings
This example returns descriptions of all reserved database instance offerings.
PROMPT> rds-describe-reserved-db-instances-offerings
Describing a Specific Reserved Instance Offering
This example returns information about a specific reserved DB instance offering.
API Version 2014-10-31
117
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
PROMPT> rds-describe-reserved-db-instances-offerings offering-id --headers
Describing Only Multi-AZ Reserved Instance Offerings
This example returns information about Multi-AZ reserved DB instance offerings.
PROMPT> rds-describe-reserved-db-instances-offerings --multi-az true
Related Operations
• rds-describe-reserved-db-instances (p. 112)
• rds-purchase-reserved-db-instances-offering (p. 143)
rds-download-db-logfile
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Downloads the specified log file.
Syntax
rds-download-db-logfile db-instance-identifier
--log-file-name value
[General Options]
Options
Name
Description
Required
--db-instanceidentifier
Customer-supplied DB instance identifier; this is the
name you assigned to the DB instance when you
created it and is the unique key that identifies a DB
instance.
Yes
API Version 2014-10-31
118
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-download-dblogfile my-db-instance-identifier.
Type: String
--log-file-name
The name of the log file to be downloaded.
Yes
Type: String
Output
The command downloads the specified log file.
Examples
Downloads a Log File
This example downloads a log file named log/ERROR.4 for a DB instance called myexampledb in the uswest-2 region.
PROMPT> rds-download-db-logfile myexampledb --region us-west-2 --log-file-name log/ERROR.4
> errorlog.txt
Related Operations
• rds-describe-db-log-files (p. 85)
rds-list-tags-for-resource
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Lists all tags associated with an Amazon RDS resource. The Amazon RDS resource is identified by its
Amazon Resource Name (ARN) To learn how to construct the ARN that references a resource, see
Constructing an RDS Amazon Resource Name (ARN).
API Version 2014-10-31
119
Amazon Relational Database Service
Command Line Interface Reference
Syntax
Syntax
rds-list-tags-for-resource resource-name [General Options]
Options
Name
Description
Required
--resource-name value
The Amazon Resource Name (ARN) of the Amazon
RDS resource that has the tags you want to list.
To learn how to construct the ARN that references
the resource to be tagged, see Constructing an
RDS Amazon Resource Name (ARN).
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdslist-tags-for-resource my-resource-name.
Output
This command returns a table that contains the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• key—The name (key) of the tag.
• value—The value of the tag.
Example
This example lists the tags of a DB instance.
PROMPT> rds-list-tags-for-resource arn:aws:rds:us-east-1:0123456789:db:my-db-instance
TAG project trinity
TAG cost-center 5092
rds-modify-db-instance
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
API Version 2014-10-31
120
Amazon Relational Database Service
Command Line Interface Reference
Description
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Changes the settings of an existing DB instance.
Syntax
rds-modify-db-instance db-instance-identifier
[--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 ]
[-ct (--copy-tags-to-snapshot) value ]
[--port value ]
[-pub (--publicly-accessible) value ]
[-g (--db-parameter-group-name) value ]
[-a (--db-security-groups)value[,value...] ]
[-sg (--vpc-security-group-ids)value[,value...] ]
[-n (--new-db-instance-identifier) value ]
[-st (--storage-type) value ]
[--iops value ]
[-og (--option-group) value ]
[-p (--master-user-password) value ]
[-m (--multi-az) value]
[-w (--preferred-maintenance-window) value ]
[-b (--preferred-backup-window) value ]
[-tca (--tde-credential-arn) value ]
[-tcp (--tde-credential-password) value ]
[ -cert (--certificate-identifier) value ]
API Version 2014-10-31
121
Amazon Relational Database Service
Command Line Interface Reference
Options
[General Options]
Options
Name
Description
Required
--db-instance-identifier value
DB instance identifier. This is the unique key that
identifies an DB instance. Stored as a lowercase
string.
Yes
-D value
This parameter is the default parameter and
can be passed as the first value in the command
and without a parameter name, for example:
rds-modify-db-instance my-db-instanceidentifier.
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
--allow-major-version-upgrade
value
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.
Conditional
Type: Boolean
Constraints: This parameter must be set to true
when specifying a value for the --engine-version
parameter that is a different major version than
the DB instance's current version.
-au value
--auto-minor-version-upgrade
value
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.
No
Type: Boolean
Example: --au true
-n value
--new-db-instance-identifier
value
Provides the new name for the DB instance when
renaming an existing instance. When you change
the DB instance identifier, an instance reboot will
occur immediately if you set apply-immediately API Version 2014-10-31
122
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
to true, or will occur during the next maintenance
window if you set apply-immediately to false.
This value is stored as a lowercase string.
Type: String
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.
Cannot be the name of an existing DB instance.
Example: rds-modify-db-instance
myDBInstanceIdentifier -n
myNewDBInstanceIdentifier
-v value
--engine-version value
Version number of the database engine to
use. 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.
Note
For major version upgrades, if a nondefault DBParameterGroup is currently
in use, a new DBParameterGroup
in the DBParameterGroupFamily
for the new engine version must be
specified. The new DBParameterGroup
can be the default for that
DBParameterGroupFamily.
Type: String
Valid values: For a list of valid values, see the -engine-version parameter in the rds-create-dbinstance (p. 31)
Example: --engine-version 5.1.42
API Version 2014-10-31
123
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
--apply-immediately
Determines when a change is applied. If set to
True, the change will be applied immediately if
possible.
No
If this parameter is set to False, changes to
the DB instance are applied during the next
maintenance window. Some parameter changes
can cause an outage and will be applied on the
next call to rds-reboot-db-instance, or the next
failure reboot. Review the table of parameters
in Modifying a DB Instance and Using the Apply
Immediately Parameter to see the impact that
setting --apply-immediately to True or False has
for each modified parameter and to determine
when the changes will be applied.
Type: Boolean
Default: False
Valid values: True | False
-r value
--backup-retention-period value
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.
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.
Type: Integer
Default: 1
Constraints:
• Must be a value from 0 to 35.
• Can be specified for a DB instance that is a Read
Replica only if the source is running MySQL 5.6,
or PostgreSQL 9.3.5, 9.3.6, or 9.4.1.
• Cannot be set to 0 if the DB instance is a source
to Read Replicas.
API Version 2014-10-31
124
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-c value
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 rds-describe-orderable-dbinstance-options (p. 109) command.
No
--db-instance-class value
Changing this parameter results in an
outage and the change is applied during
the next maintenance window, unless the
ApplyImmediately parameter is specified as true
for this request.
Type: String
Default: None
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
| db.m3.medium | db.m3.large | db.m3.xlarge |
db.m3.2xlarge | db.r3.large | db.r3.xlarge |
db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge
| db.t2.micro | db.t2.small | db.t2.medium
| db.t2.large | db.m4.large | db.m4.xlarge
| db.m4.2xlarge | db.m4.4xlarge |
db.m4.10xlarge
Example: --db-instance-class db.m1.xlarge
Example: --db-instance-class db.m1.xlarge
Note
Amazon RDS does not support
db.t1.micro instances in a virtual private
cloud (VPC).
True to copy all tags from the DB instance to
snapshots of the DB instance; otherwise false. The
default is false.
--copy-tags-to-snapshot
-ct
-g value
--db-parameter-group-name value
No
Name of the DB parameter group to associate
No
with this DB instance. Changing this setting does
not result in an outage. The parameter group
name itself is changed immediately, but the
actual parameter changes are not applied until
you reboot the instance without failover. The DB
instance will NOT be rebooted automatically and
the parameter changes will NOT be applied during
the next maintenance window.
Type: String
Example: --db-parameter-group-name
MyDBParameterGroup
API Version 2014-10-31
125
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-a value [,value...]
A list of one or more DB security groups to
associate with this DB instance. Changing this
parameter does not result in an outage and the
change is asynchronously applied as soon as
possible.
No
--db-security-groups value
[,value...]
Type: String[]
Example: --db-security-groups
mysecuritygroup1, mysecuritygroup2
-sg value
--vpc-security-group-ids value
[,value...]
A list of the IDs of one or more VPC security
groups to associate with this DB instance.
Type: String[]
Example: --vpc-security-group-ids sge763f78e, sg-e0690405
API Version 2014-10-31
126
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-p value
Password for the master database user. Changing
this parameter does not result in an outage and
the change is asynchronously applied as soon as
possible.
No
--master-user-password value
Note
Amazon RDS CLI commands never return
the password, so this action provides a
way to regain access to a master instance
user if the password is lost. This includes
restoring privileges that may have been
accidentally revoked.
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.
PostgreSQL
Constraints: Must contain from 8 to 128
alphanumeric characters.
Example: --master-user-password
mysecretpassword01
-st value
Specifies the storage type for the DB instance.
--storage-type value
Type: String
Valid values: standard | gp2 | io1.
Default: io1 if the --iops parameter is specified;
otherwise standard
If you specify io1, you must also include a value
for the --iops parameter.
API Version 2014-10-31
127
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
--iops value
Specifies the new amount of provisioned IOPS for
the DB instance, expressed in I/O operations per
second. 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.
No
This option can only be specified if the database
instance was created with iops specified. The iops
and allocated-storage options cannot both be
specified in the same request. To set or remove
the iops option, or to change the iops-to-storage
ratio, create a new database instance and then
restore a database instance from a snapshot or to
a point-in-time restore.
Constraints: Must be an integer greater than
1000. The value must also be a multiple of the
storage amount for the DB instance and can
be from 3-10 times the storage amount. For
example, if the size of your DB instance is 500GB,
then your --iops value can be 2000, 3000, 4000,
or 5000.
You can set the --iops value to 0 to disable
provisioned IOPS for a DB instance.
Example: rds-modify-db-instance exampledb -region us-west-2 --iops 0 --s 100 --applyimmediately
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.
SQL Server
API Version 2014-10-31
128
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
You cannot change the provisioned IOPS for a
SQL Server DB instance.
-m value
--multi-az value
Specifies if this 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. Not a valid option for SQL Server
Multi-AZ mirrored instances. To configure MultiAZ for a SQL Server instance, apply or remove the
"Mirroring" option using Option Groups.
No
Type: Boolean
Default: false
Valid values: true | false
Constraints: Cannot be specified if the DB instance
is a Read Replica.
-og value
--option-group value
Specifies the option group to be applied.
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.
Note that persistent options, such as the
TDE_SQLServer option for Microsoft SQL Server,
cannot be removed from an option group while
DB instances are associated with the option group.
Permanent options, such as the TDE option for
Oracle Advanced Security TDE, can never 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.
Type: String
API Version 2014-10-31
129
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-s value
Amount of storage to be allocated for the DB
instance, in gigabytes. 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.
No
--allocated-storage value
Type: Integer
Example: --allocated-storage 20
MySQL and PostgreSQL
Must be an integer from 5 to 6144.
Oracle
Must be an integer from 10 to 6144.
SQL Server
You cannot change the allocated storage for a
SQL Server DB instance.
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.
API Version 2014-10-31
130
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-w value
Preferred maintenance window for the DB
instance.
No
--preferred-maintenance-window
value
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.
Type: String
Constraints: Must be in the format ddd:hh24:middd:hh24:mi. Times should be 24-hour Universal
Time Coordinated (UTC). Must be at least 30
minutes. See example below.
Example: rds-modify-db-instance myinstance
--preferred-maintenance-window Tue:04:00Tue:04:30
--preferred-backup-window value
-b value
The daily time range during which automated
backups are created if backups are enabled (using
the --backup-retention-period). Changing this
parameter does not result in an outage and the
change is asynchronously applied as soon as
possible.
No
Type: String
Constraints: Must be in the format hh24:mihh24:mi. Must be at least 30 minutes. Times
should be 24-hour Universal Time Coordinated
(UTC). Must not conflict with the --preferredmaintenance-window.
-tca value
--tde-credential-arn value
-tcp value
--tde-credential-password value
--certificate-identifier value
-cert value
The ARN of the HSM HA Partition Group used for
the TDE HSM option.
No
The password of the HSM HA Partition Group
used for the TDE HSM option.
No
Identifier of the CA certificate to be associated
with DB Instance.
No
API Version 2014-10-31
131
Amazon Relational Database Service
Command Line Interface Reference
Output
Output
The command returns a table that contains the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• 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
• CopyTagsToSnapshot—Specifies whether tags are copied from the DB instance to snapshots 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
• Storage Type—The type of storage specified
• Storage Encrypted—Indicates whether the DB instance is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB instance
• Resource Id—If Storage Encrypted is true, the region-unique, immutable identifier for the encrypted
DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB
instance is accessed.
• 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-credentials
• Endpoint Address—Address of the DB instance
• Port—Port used to connect to the DB instance
• AZ—The instance's Availability Zone
• IOPS—The provisioned storage allocated, expressed as I/O operations per second
• 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 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-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.
• License—The license model used for this DB instance
• Security GroupName—DB security group name
API Version 2014-10-31
132
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Authorization Status—Status of authorization. Valid values: authorizing | authorized | revoking
• Publicly Accessible—Indicates the accessibility option of the instance. A value of true specifies an
Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A
value of false specifies an internal instance with a DNS name that resolves to a private IP address.
• 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
• Read Replica Source Identifier—The identifier of the source DB instance for which this DB instance
acts as a Read Replica
• Subnet Group Name—Subnet group name
• Description—Subnet group description
• VpcId—Identifier of the VPC associated with the subnet group
• VPC security group Ids—Identifier of the VPC security groups associated with the instance
• Subnet identifier—Subnet group identifier
• Subnet Availability Zone—Availability Zone of the subnet
• CACertificateIdentifier—Specifies the name of the CA certificate associated with the DB instance.
• PendingCACertificateIdentifier—Specifies the name of the CA certificate to be associated with the DB
instance.
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
API Version 2014-10-31
133
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
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
Change the CA certificate associated with a Database Instance
This example shows how to change the CA certificate for a DB instance.
PROMPT> rds-modify-db-instance -cert rds-ca-2015
Related Operations
• rds-create-db-instance (p. 31)
• rds-delete-db-instance (p. 69)
• rds-describe-db-instances (p. 81)
rds-modify-db-parameter-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Updates the parameters in a parameter group. You can update up to 20 values per call.
API Version 2014-10-31
134
Amazon Relational Database Service
Command Line Interface Reference
Syntax
Note
Amazon RDS does not support passing multiple comma-delimited parameter values for a single
parameter.
Important
After you modify a DB parameter group, you should wait at least 5 minutes before creating
your first DB instance that uses that DB parameter group as the default parameter group. This
allows Amazon RDS to fully complete the modify action before the parameter group is used as
the default for a new DB instance. This is especially important for parameters that are critical
when creating the default database for a DB instance, such as the character set for the default
database defined by the character_set_database parameter. You can use the Parameter
Groups option of the Amazon RDS console or the rds-describe-db-parameters (p. 88)
command to verify that your DB parameter group has been created or modified.
Syntax
rds-modify-db-parameter-group db-parameter-group-name
-p (--parameters) "name=value, value=value, method=value"[,
"name=value, value=value, method=value"][,
...]
[General Options]
Options
Name
Description
Required
--db-parameter-group-name
DB parameter group identifier. Stored as a
lowercase string.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsmodify-db-parameter-group my-db-parametergroup-name.
Constraints: Must contain from 1 to 255
alphanumeric characters or hyphens. First
character must be a letter. Cannot end with a
hyphen or contain two consecutive hyphens.
-p
--parameters "name=value,
value=value, method=value"
A string containing a series of parameter names,
values, and the update method for the parameter
update. The first --parameters argument is
required; subsequent arguments are optional. A
maximum of 20 parameters may be updated in
a single call to the rds-modify-parameter-group
command.
To obtain a list of the parameters that make up a
parameter group, with their values, use the rdsdescribe-db-parameters (p. 88) command. Only
parameters that are marked as modifiable can be
changed.
API Version 2014-10-31
135
Yes
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
Valid values (method): immediate | pendingreboot.
If immediate, the change takes effect immediately.
If pending-reboot, the change takes effect the
next time that the DB instance is rebooted.
The immediate method can be used only for
dynamic parameters; the pending-reboot method
can be used with MySQL and Oracle DB instances
for either dynamic or static parameters. For
Microsoft SQL Server DB instances, the pendingreboot parameter can be used only for static
parameters.
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group Name—The name of the parameter group that was modified.
Examples
Modify Parameters in a Parameter Group
This example shows how to modify a group of parameters in a parameter group.
PROMPT> rds-modify-db-parameter-group mydbparametergroup --parameters
"name=max_user_connections, value=24, method=pending-reboot" "name=max_allowed_packet,
value=1024, method=immediate"
Related Operations
• rds-create-db-parameter-group (p. 55)
• rds-delete-db-parameter-group (p. 73)
• rds-describe-db-parameter-groups (p. 86)
rds-modify-db-subnet-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
API Version 2014-10-31
136
Amazon Relational Database Service
Command Line Interface Reference
Description
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Updates an existing DB subnet group.
Syntax
rds-modify-db-subnet-group db-subnet-group-name
-d (--db-subnet-group-description) value
-s (--db-subnet-list) "value" [,value,...]]
[General Options]
Options
Name
Description
Required
--db-subnet-group-name value
DB subnet group identifier.
Yes
-n value
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsmodify-db-subnet-group my-db-subnet-groupname.
Constraints: Must contain from 1 to 255
alphanumeric characters or hyphens. First
character must be a letter. Cannot end with a
hyphen or contain two consecutive hyphens.
-d
The description of the DB subnet group
--db-subnet-group-description
value
Constraints: Cannot contain more than 255
characters.
-s
A comma-delimited list of subnets to include in
this DB subnet group.
--db-subnet-list value[,value,
value...]
No
No
Constraints: Cannot contain more than 255
characters.
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
API Version 2014-10-31
137
Amazon Relational Database Service
Command Line Interface Reference
Examples
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Name—The name of the DB subnet group that was modified.
• Description—The description of the DB subnet group that was modified.
• Status—The status of the DB subnet group that was modified.
• Subnet Identifier—The identifier of a contained subnet.
• Subnet Availability Zone—The Availability Zone of the contained subnet.
• Status—The status of the contained subnet.
Examples
Modify Parameters in a Parameter Group
This example shows how to modify a DB subnet group.
PROMPT> rds-modify-db-subnet-group --db-subnet-group-name mygroup --db-subnet-groupdescription "My Subnet Group" --db-subnet-list subnet1,subnet2,subnet3
SUBNETGROUP Name
Description
Status
SUBNETGROUP mygroup my group desc Active
SUBNET Subnet Identifier Subnet Availability Zone
SUBNET mytestgroup
us-east-1c
Status
Active
Related Operations
• rds-create-db-subnet-group (p. 62)
• rds-delete-db-subnet-group (p. 77)
• rds-describe-db-subnet-groups (p. 96)
rds-modify-event-subscription
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Modifies an existing RDS event notification subscription. Note that you cannot modify the source
identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifier
and RemoveSourceIdentifier calls.
API Version 2014-10-31
138
Amazon Relational Database Service
Command Line Interface Reference
Syntax
You can see a list of the event categories and source types in the Events topic in the Amazon Relational
Database Service User Guide or by using the DescribeEventCategories action.
Syntax
rds-modify-event-subscription subscription-name
-t (--sns-topic-arn) value
[--event-categories) value ]
[-s (--source-type) value ]
[--disable value ]
[General Options]
Options
Name
Description
Required
--subscription-name value
The name of the subscription to be modified.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsmodify-event-subscription my-subscriptionname.
Type: String
Constraints: The name must be less than 255
characters.
Example: --subscription-name mysubscription1
-t
--sns-topic-arn value
--event-categories value
-a value
The Amazon Resource Name (ARN) of the Amazon
SNS topic created for event notification. The ARN
is created by Amazon SNS when you create a topic
and subscribe to it.
No
A list of event categories for a source-type that
you want to subscribe to.You can see a list of the
categories for a given source-type in the Events
topic in the Amazon Relational Database Service
User Guide.
No
Type: String list
-s
--source-type value
The type of source that will be generating the
events. For example, if you want to be notified of
events generated by a DB instance, you would set
this parameter to db-instance. if this value is not
specified, all events are returned.
Valid values: db-instance | db-parameter-group |
db-security-group | db-snapshot
Type: String
API Version 2014-10-31
139
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
--disable value
A Boolean value; set to false to activate the
subscription. You can set this value to true if you
want to create the subscription but not activate it.
The default is true.
No
Type: Boolean
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• CustSubscriptionId—the Id of the event subscription
• CustomerAwsId—the AWS customer account associated with the Amazon RDS event notification
subscription
• Enabled—a Boolean value indicating if the subscription is enabled. True indicates the subscription is
enabled
• EventCategoriesList—a list of event categories for the RDS event notification subscription
• SnsTopicArn—the Amazon SNS topic's ARN for the Amazon RDS event notification subscription
• SourceIdsList—a list of source Ids for the Amazon RDS event notification subscription
• SourceType—the source type for the Amazon RDS event notification subscription
• Status—the status of the Amazon RDS event notification subscription. Can be one of the following:
creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the Amazon SNS
topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was
created.
• SubscriptionCreationTime—the time the Amazon RDS event notification subscription was created
Examples
Modifying an event subscription
This example modifies an existing subscription called MySubscription1 to include several event
categories.
PROMPT> rds-modify-event-subscription MySubscription1 --EventCategories Creation, Deletion,
Failure, Failover
Modifying an event subscription with multiple event categories
This example modifies a subscription called MySubscription2.
API Version 2014-10-31
140
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
PROMPT> rds-modify-event-subscription MyProductionSubscription --SourceType MyDBInstance1,
MyDBInstance2,
MyDBSecGrp1, MyParmGrp --SourceType db-instance, db-parameter-group, db-security-group -EventCategories Failover, Failure, Configuration Change
Related Operations
• rds-add-source-identifier-to-subscription (p. 15)
• rds-remove-source-identifier-from-subscription (p. 150)
• rds-create-event-subscription (p. 64)
• rds-describe-event-subscriptions (p. 104)
rds-promote-read-replica
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a new DB instance from a Read Replica.
Note
We recommend that you enable automated backups on your Read Replica before promoting
the Read Replica. This ensures that no backup is taken during the promotion process. Once the
instance is promoted to a primary instance, backups are taken based on your backup settings.
Syntax
rds-promote-read-replica db-instance-identifier
[-r (--backup-retention-period) value ]
[-b (--preferred-backup-window) value ]
[General Options]
Options
Name
Description
Required
--db-instance-identifier value
The database instance identifier of the Read
Replica to be promoted. The identifier consists of
Yes
API Version 2014-10-31
141
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
1 to 63 alphanumeric characters or hyphens, is
case insensitive, and is not case preserving.
This parameter is the default parameter and
can be passed as the first value in the command
and without a parameter name, for example:
rds-promote-read-replica my-db-instanceidentifier.
The number of days automated backups are
retained. Setting this parameter to a positive
number enables backups. Setting this parameter
to 0 disables backups.
--backup-retention-period
-r
No
Type: Integer
Default: 1
Constraints: Must be a value from 0 to 35.
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• 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
• Storage Type—The type of storage specified
• Storage Encrypted—Indicates whether the DB instance is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB instance
• Resource Id—If Storage Encrypted is true, the region-unique, immutable identifier for the encrypted
DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB
instance is accessed.
• 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
• Endpoint Address—Address of the DB instance
• Port—Port used to connect to the DB instance
• AZ—The instance's Availability Zone
• SecondaryAZ—When the DB instance has multi-AZ support, this value is the secondary AZ.
• Backup Retention—The number of days that automated backups are retained before deletion
API Version 2014-10-31
142
Amazon Relational Database Service
Command Line Interface Reference
Example
• 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 or the Oracle System
ID (SID) of the created DB instance (for the Oracle engine). This column appears only in the --showlong 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.
• Iops—The provisioned storage IOPS, expressed as I/O operations per second.
• 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.
• Replication State—The status of the Read Replica replication.
• Change Date—The date of the last replication state change for the Read Replica.
Example
This example shows how to promote a Read Replica to be a DB instance.
PROMPT> rds-promote-read-replica mydbinstance
This example shows how to promote Read Replica instance and set backup retention to 1 day with the
preferred backup window for the db to be 1 hour starting daily at 9:15 PM and ending at 10:15 AM
PROMPT> rds-promote-read-replica mydbinstance -r 1 -b 21:15-22:15
rds-purchase-reserved-db-instances-offering
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
API Version 2014-10-31
143
Amazon Relational Database Service
Command Line Interface Reference
Description
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Purchases a reserved DB instance offering. Note that you can move Reserved Instances from an EC2Classic (non-VPC) instance into a VPC without additional charge.
Syntax
rds-purchase-reserved-db-instance-offering
[-c (--instance-count) value ]
[-i (--reserved-db-instance-id) value ]
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
reserved-db-instances-offering-id
Options
Name
Description
Required
--reserved-db-instancesoffering-id value
The ID of the Reserved DB instance offering to
purchase.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdspurchase-reserved-db-instances-offering myreserved-db-instances-offering-id.
Type: String
Default: None
Example: --reserved-db-instances-offering-id
myreserveddbinstance
-c
The number of DB instances to reserve.
--instance-count value
Type: Integer
No
Default: 1
Example: -c 3
-i
--reserved-db-instance-id value
Optional unique identifier for the purchased
reservation. If this parameter is not specified,
an identifier is automatically generated for the
reservation.
API Version 2014-10-31
144
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
Type: String
Default: None
Example: -i myreservationID
--tag-key
-tk
--tag-value
-tv
The name of a tag to add for the purchased
reservation.
No
The value of the tag to add for the purchased
reservation.
No
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• ReservationId—the unique identifier for the reservation.
• OfferingID—the offering identifier (only appears when the --show-long parameter is specified).
• Class—the DB instance class for the reservation.
• Multi-AZ—indicates if the reservation applies to Multi-AZ deployments.
• Start Time—the time the reservation started
• Duration—the length of the duration in years.
• Fixed Price—the fixed price charged for each DB instance in this reservation (only appears when the -show-long parameter is specified).
• Usage Price—the hourly price to run each reserved DB instance (only appears when the --show-long
parameter is specified).
• Count—the number of database instances reserved.
• State—the payment status of the reservation.
• Description—the database engine used by the reservation.
Examples
Reserve a Database Instance
This example reserves a single database instance from offering 438012d3-4052-4cc7b2e3-8d3372e0e706.
PROMPT> rds-purchase-reserved-db-instances-offering 438012d3-4052-4cc7-b2e3-8d3372e0e706 -i
myreservationID
API Version 2014-10-31
145
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
Reserve Multiple Database Instances
This example reserves five database instances from offering 438012d3-4052-4cc7-b2e3-8d3372e0e706.
PROMPT> rds-purchase-reserved-db-instances-offering 438012d3-4052-4cc7-b2e3-8d3372e0e706 i myreservationID -c 5
Related Operations
• rds-describe-reserved-db-instances (p. 112)
• rds-describe-reserved-db-instances-offerings (p. 115)
rds-reboot-db-instance
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Reboots a DB instance. Once started, the process cannot be stopped, and the DB instance is unavailable
until the reboot is completed.
Syntax
rds-reboot-db-instance db-instance-identifier
[--force-failover value ][General Options]
Options
Name
Description
Required
--db-instanceidentifier value
DB instance identifier.
Yes
This parameter is the default parameter and can be
passed as the first value in the command and without
a parameter name, for example: rds-reboot-dbinstance my-db-instance-identifier.
Constraints: Must contain 1 to 63 alphanumeric
characters or hyphens. First character must be a
letter. Cannot end with a hyphen or contain two
consecutive hyphens.
API Version 2014-10-31
146
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
--force-failover value
When true, specifies that the reboot will be
conducted through a Multi-AZ failover. You cannot
specify true if the DB instance is not configured for
Multi-AZ.
No
Type: Boolean
Default: false
Example: --force-failover true
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• 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
• Storage Type—The type of storage specified
• Storage Encrypted—Indicates whether the DB instance is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB instance
• Resource Id—If Storage Encrypted is true, the region-unique, immutable identifier for the encrypted
DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB
instance is accessed.
• 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-credentials
• 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 or the Oracle System
ID (SID) of the created DB instance (for the Oracle engine). This column appears only in the --showlong view
•
•
•
•
• Maintenance Window—The period during which patching and instance modifications will be
performed. This column appears only in the --show-long view.
API Version 2014-10-31
147
Amazon Relational Database Service
Command Line Interface Reference
Examples
• 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
Reboot a Database Instance
This example reboots a DB instance.
PROMPT> rds-reboot-db-instance databaseInstance1
Related Operations
• rds-delete-db-instance (p. 69)
• rds-describe-db-instances (p. 81)
rds-remove-option-from-option-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Removes one or more specified options from an option group.
Syntax
rds-remove-option-from-option-group option-group-name
--options value[,value 2][,...]
"
[--apply-immediately]
API Version 2014-10-31
148
Amazon Relational Database Service
Command Line Interface Reference
Options
Options
Name
Description
Required
--option-group-name value
Name of the option group that the specified
option or options will be removed from.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsremove-option-from-option-group my-optiongroup-name.
--options
-o
--apply-immediately
A comma-separated list of options that will be
removed.
Yes
If supplied, the options will be immediately
disabled for all associated DB instances;
otherwise, the options will be disabled for each
DB instance at its next maintenance window.
No
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group name—The name of the option group that options will be removed from.
• Engine—The DB engine that the option group is associated with
• Major engine version—The major version of the DB engine.
• Description—The description of the option group.
• VPC Specific—Indicates if both VPC and non-VPC instances can join this option group.
• VPC—Indicates if only instances in this VPC can join this option group.
•
•
•
•
Name—The name of the option.
Port—The port used by this option, if applicable.
Description—The description of the option.
Name—The security group name.
• Status—The status of authorization.
Examples
The following example removes the Oracle Enterprise Manager Database Control option from an option
group named TestOptionGroup. For DB instances that use TestOptionGroup, the option will be removed
at the next maintenance window for each instance:
API Version 2014-10-31
149
Amazon Relational Database Service
Command Line Interface Reference
rds-remove-source-identifier-from-subscription
PROMPT> rds-remove-option-from-option-group TestOptionGroup --options OEM
OPTIONGROUP testoptiongroup oracle-ee 11.2 Oracle Enterprise Manager Database Control
rds-remove-source-identifier-from-subscription
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Removes a source identifier from an existing Amazon RDS event notification subscription.
Syntax
rds-remove-source-identifier-from-subscription subscription-name
--source-id value
[General Options]
Options
Name
Description
Required
--subscription-name value
The name of the subscription.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsremove-source-identifier-from-subscription
my-subscription-name.
Type: String
Constraints: The name must be less than 255
characters.
Example: --subscription-name mysubscription1
--source-id value
The source identifier to be removed from the
subscription. An identifier must begin with a letter
and must contain only ASCII letters, digits, and
hyphens; it cannot end with a hyphen or contain
two consecutive hyphens.
Type: String
Constraints:
API Version 2014-10-31
150
Yes
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
If the source type is a DB instance, then a DB
instance identifier must be supplied.
If the source type is a DB security group, a DB
security group name must be supplied.
If the source type is a DB parameter group, a DB
parameter group name must be supplied.
If the source type is a DB snapshot, a DB snapshot
identifier must be supplied.
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• CustSubscriptionId—the Id of the event subscription
• CustomerAwsId—the AWS customer account associated with the Amazon RDS event notification
subscription
• Enabled—a Boolean value indicating if the subscription is enabled. True indicates the subscription is
enabled
• EventCategoriesList—a list of event categories for the Amazon RDS event notification subscription
• SnsTopicArn—the Amazon SNS topic's ARN for the Amazon RDS event notification subscription
• SourceIdsList—a list of source Ids for the RDS event notification subscription
• SourceType—the source type for the Amazon RDS event notification subscription
• Status—the status of the RDS event notification subscription. Can be one of the following: creating |
modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the Amazon SNS
topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was
created.
• SubscriptionCreationTime—the time the RDS event notification subscription was created
Examples
Removing a source identifier from an event subscription
This example removes the DB instance named MyDBInstance1 from the MySubscription1 subscription.
PROMPT> rds-remove-source-identifier-from-subscription MySubscription1 --SourceIdentifier
MyDBInstance1
API Version 2014-10-31
151
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
Related Operations
• rds-add-source-identifier-to-subscription (p. 15)
• rds-create-event-subscription (p. 64)
• rds-modify-event-subscription (p. 138)
• rds-describe-event-subscriptions (p. 104)
rds-remove-tags-from-resource
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Removes a tag for each key specified from an Amazon RDS resource. The Amazon RDS resource is
identified by its Amazon Resource Name (ARN). To learn how to construct the ARN that references the
resource, see Constructing an RDS Amazon Resource Name (ARN)
Syntax
rds-remove-tags-from-resource resource-name
Options]
-k (--keys) value[,value2...]
[General
Options
Name
Description
Required
--resource-name
The Amazon Resource Name (ARN) of the Amazon
RDS resource that has the tag to be removed. To
learn how to construct the ARN that references
the resource, see Constructing an RDS Amazon
Resource Name (ARN).
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rds-
remove-tags-from-resource my-resource-name.
--keys
The keys of the tags to be deleted.
-k
Output
This command does not return any output.
API Version 2014-10-31
152
Yes
Amazon Relational Database Service
Command Line Interface Reference
Example
Example
This example deletes tags on a DB instance that have the keys "project" and "cost-center." No output is
returned.
PROMPT> rds-remove-tags-from-resource arn:aws:rds:us-east-1:0123456789:db:my-db-instance k project,cost-center
rds-reset-db-parameter-group
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Resets individual parameters or all parameters in a parameter group to engine defaults.
Syntax
rds-reset-db-parameter-group db-parameter-group-name
[-p (--parameters) "name=value, method=value" ...]]
[--reset-all-parameters ] [General Options]
Options
Name
Description
Required
--db-parameter-group-name value
DB parameter group identifier.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsreset-db-parameter-group my-db-parametergroup-name.
Constraints: Must contain from 1 to 255
alphanumeric characters or hyphens. First
character must be a letter. Cannot end with a
hyphen or contain two consecutive hyphens.
API Version 2014-10-31
153
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-p
A string containing a series of parameter names,
values, and apply methods. A maximum of 20
parameters may be reset in a single call to the
rds-reset-db-parameter-group command.
Conditional
--parameters "name=value,
method=value"
Valid values (for apply method): immediate |
pending-reboot
Constraints: Cannot be specified if --reset-allparameters is specified.
--reset-all-parameters
Specifies that all parameters in the group should
be reset to their defaults.
Conditional
Constraints: Cannot be specified if --parameters
string is specified.
Output
The command returns the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group Name—the name of the parameter group that was modified.
Examples
Reset Parameters in a Parameter Group
This example shows how to reset some parameters in a parameter group.
PROMPT> rds-reset-db-parameter-group mydbparametergroup
--parameters "name=max_user_connections, method=pending-reboot" "name=max_allowed_packet,
method=immediate"
Reset Parameters in a Parameter Group
This example shows how to reset all parameters in a parameter group.
PROMPT> rds-reset-db-parameter-group mydbparamgrp --reset-all-parameters
API Version 2014-10-31
154
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
Related Operations
• rds-create-db-parameter-group (p. 55)
• rds-delete-db-parameter-group (p. 73)
• rds-describe-db-parameter-groups (p. 86)
rds-restore-db-instance-from-db-snapshot
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Creates a new DB instance from a DB snapshot of an existing DB instance, effectively replicating the
existing instance at the time the DB snapshot was taken. Some characteristics of the new DB instance can
be modified using optional parameters; if these are omitted, the new restored DB instance defaults to
the characteristics of the DB instance from which the snapshot was taken.
Note
This operation is not supported for Read Replica DB instances.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename
your original DB instance before you call the rds-restore-db-instance-from-db-snapshot command.
RDS does not allow two DB instances with the same name. Once you have renamed your original DB
instance with a different identifier, then you can pass the original name of the DB instance as the dbinstance-identifier in the call to the rds-restore-db-instance-from-db-snapshot command. The
result is that you will replace the original DB instance with the DB instance created from the snapshot.
Syntax
rds-restore-db-instance-from-db-snapshot db-instance-identifier
-s (--db-snapshot-identifier) value
[-e (--engine) value ]
[-lm (--license model) value ]
[-z (--availability-zone) value ]
[-c (--db-instance-class) value ]
[-ct (--copy-tags-to-snapshot) value ]
[-st (--storage-type) value ]
[--iops value ]
[-pub (--publicly-accessible) value]
[-m (--multi-az) value ]
[-og (--option-group) value ]
API Version 2014-10-31
155
Amazon Relational Database Service
Command Line Interface Reference
Options
[-sn (--db-subnet-group-name) value ]
[-n (--db-name) value ]
[-p (--port) value ]
[-au (--auto-minor-version-upgrade) value ]
[-tca (--tde-credential-arn) value ]
[-tcp (--tde-credential-password) value ]
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
-i value
DB instance identifier. This is the unique key that
identifies a DB instance. Stored as a lowercase
string.
Yes
--db-instance-identifier value
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsrestore-db-instance-from-db-snapshot my-dbinstance-identifier.
Type: String
Default: None
Constraints: Must contain 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
-z value
--availability-zone value
The Amazon EC2 Availability Zone that the DB
instance will be created in.
No
Type: String
Default: A random, system-chosen Availability
Zone.
Example: -z us-east-1c
-s value
The identifier for an existing DB snapshot.
--db-snapshot-identifier value
Type: String
Default: None
Constraints: Cannot be null, empty, or blank. Must
contain from 1 to 255 alphanumeric characters or
hyphens. First character must be a letter. Cannot
API Version 2014-10-31
156
Yes
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
end with a hyphen or contain two consecutive
hyphens.
Example: -s my-snapshot-id
-e value
--engine value
Name of the database engine to use for the new
DB instance.
No
Type: String
Default: Same as the source DB instance.
Valid values: MySQL | oracle-se1 | oracle-se |
oracle-ee
-c value
--db-instance-class value
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 rds-describe-orderable-dbinstance-options (p. 109) command.
No
Type: String
Default: None
Valid values: db.t1.micro | db.m1.small |
db.m1.medium | db.m1.large | db.m1.xlarge |
db.m2.2xlarge | db.m2.4xlarge | db.m3.medium
| db.m3.large | db.m3.xlarge | db.m3.2xlarge
| db.r3.large | db.r3.xlarge | db.r3.2xlarge
| db.r3.4xlarge | db.r3.8xlarge | db.t2.micro
| db.t2.small | db.t2.medium | db.t2.large |
db.m4.large | db.m4.xlarge | db.m4.2xlarge |
db.m4.4xlarge | db.m4.10xlarge
Example: --db-instance-class db.m1.xlarge
Example: --db-instance-class db.m1.xlarge
No
-ct
True to copy all tags from the restored DB
instance to snapshots of the DB instance;
otherwise false. The default is false.
-lm
License model for the new DB instance.
No
--license-model value
Type: String
--copy-tags-to-snapshot
Default: Same as the source DB instance.
Valid values: license-included | bring-your-ownlicense | general-public-license
Example: --license-model bring-your-ownlicense
API Version 2014-10-31
157
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-sn value
The name of the DB subnet group to restore into.
Specifying a DB subnet group will restore to a DB
instance in the named VPC.
No
--db-subnet-group-name value
Note
You can restore a DB instance from a VPC
to a DB instance in another VPC, or from
a non-VPC DB instance into a DB instance
in a VPC. You cannot restore from a VPC
to a DB instance that is not in a VPC.
Type: String
Default: none
Constraints: Must be the name of an existing DB
subnet group.
Example: --db-subnet-group-name
mydbsubnetgroup
-st value
Specifies the storage type for the DB instance.
--storage-type value
Type: String
No
Valid values: standard | gp2 | io1.
Default: io1 if the --iops parameter is specified;
otherwise standard
If you specify io1, you must also include a value
for the --iops parameter.
--iops value
Specifies the amount of provisioned IOPS for
the DB instance, expressed in I/O operations per
second.
If this parameter is not specified, the IOPS value
will be taken from the backup. If this parameter
is set to 0, the new instance will be converted to
a non-PIOPS instance, which will take additional
time, though your DB instance will be available for
connections before the conversion starts.
Constraints: Must be an integer greater than
1000.
SQL Server
You cannot change the provisioned IOPS for a
SQL Server DB instance.
API Version 2014-10-31
158
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-pub value
Specifies the accessibility options for the DB
instance. A value of true specifies an Internetfacing instance with a publicly resolvable DNS
name, which resolves to a public IP address. A
value of false specifies an internal instance with a
DNS name that resolves to a private IP address.
No
--publicly-accessible value
If you change this setting from true to false, you
break any connections to the DB instance that are
using the public IP address.
-m value
--multi-az value
Specifies if the new DB instance is a Multi-AZ
deployment. Not a valid option for SQL Server
Multi-AZ mirrored instances. To configure MultiAZ for a SQL Server instance, apply or remove the
"Mirroring" option using Option Groups.
No
Type: Boolean
Default: false
Valid values: true | false
Constraints: The --availability-zone parameter
cannot be set if the --multi-az parameter is set
to true.
-og value
--option-group value
Specifies the name of the option group that
should be associated with this instance.
Permanent options, such as the TDE option for
Oracle Advanced Security TDE, can never 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.
Type: String
API Version 2014-10-31
159
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-n value
The value of this parameter differs according to
the database engine you use.
No
--db-name value
MySQL
Name of a database to create when the DB
instance is created. If this parameter is not
specified, no database is created in the instance.
Constraints:
• Cannot be empty.
• Must contain 1 to 64 alphanumeric characters.
• Cannot be a word reserved by the specified
database engine.
Type: String
Example: --db-name MyDatabase
PostgreSQL
Name of a database to create when the DB
instance is created. If this parameter is not
specified, the default "postgres" database is
created on the instance.
Constraints:
• Must contain 1 to 63 alphanumeric characters.
• Cannot be a word reserved by the specified
database engine.
Type: String
Example: --db-name pgDatabase
Oracle
The Oracle System ID (SID) of the created DB
instance.
Constraints:
• Cannot be longer than 8 characters.
Type: String
Example: --db-name MYORACLE
API Version 2014-10-31
160
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-p value
Port number that the DB instance uses for
connections.
No
--port value
Type: Integer
Default: The value used in the DB snapshot
Example: --port 1234
Indicates that minor version upgrades will be
applied automatically to the DB instance during
the maintenance window.
-au value
--auto-minor-version-upgrade
value
No
Type: Boolean
Example: --au true
-tca value
--tde-credential-arn value
-tcp value
--tde-credential-password value
--tag-key
-tk
--tag-value
-tv
The ARN of the HSM HA Partition Group used for
the TDE HSM option.
No
The password of the HSM HA Partition Group
used for the TDE HSM option.
No
The name of a tag to add for the restored DB
instance.
No
The value of the tag to add for the restored DB
instance.
No
Output
The command returns a table that contains the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• DBInstanceID—the user-supplied database identifier
• Created—the data and time the instance was created, in UTC
• Class—The compute and memory capacity of the DB instance
• CopyTagsToSnapshot—Specifies whether tags are copied from the DB instance to snapshots 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
• Storage Type—The type of storage specified
• Storage Encrypted—Indicates whether the DB instance is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB instance
API Version 2014-10-31
161
Amazon Relational Database Service
Command Line Interface Reference
Examples
• Resource Id—If Storage Encrypted is true, the region-unique, immutable identifier for the encrypted
DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB
instance is accessed.
• Iops—The provisioned storage IOPS, expressed as I/O operations per second.
• Master Username—The master username for the DB instance
• Status—The current status of the instance. Valid values: available | backing-up | creating | deleted |
deleting | failed | modifying | rebooting | resetting-master-credentials
• SecondaryAvailabilityZone—If present, specifies the name of the secondary Availability Zone for a DB
instance with multi-AZ support.
• Endpoint Address—Address of the DB instance
• Port—Port used to connect to the DB instance
• AZ—The instance's Availability Zone
• 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
• PendingStorage—The storage size 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
• DB Name—Name of the initial database created when the instance was created or the Oracle System
ID (SID) of the created DB instance (for the Oracle engine). This column appears only in the --showlong view
• Maintenance Window—The window during which patching and instance modifications will be
performed. This column appears only in the --show-long view
• Name—security group name
• Status—Status of authorization. Valid values: authorizing | authorized | revoking
• Name—DB subnet group name
• Description—DB subnet group description
• Group Name—Name of DB parameter group applied to
• Apply Status—Status of applying the 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
Restore a Database from a Snapshot with Minimal Parameters
This example restores a database from a DB snapshot with the minimal set of parameters.
PROMPT> rds-restore-db-instance-from-db-snapshot mynewrestoreddatabase -s
myexistingsnapshot
Restore a Database from a Snapshot, Specifying a New
Availability Zone
This example restores a database from a DB snapshot with a new Availability Zone.
API Version 2014-10-31
162
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
PROMPT> rds-restore-db-instance-from-db-snapshot mynewrestoreddatabase -s
myexistingsnapshot -c db.m1.large -p 3501 -z us-east-1a
Related Operations
• rds-delete-db-snapshot (p. 75)
• rds-describe-db-snapshots (p. 91)
rds-restore-db-instance-to-point-in-time
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Restores a DB instance to a specified point in time, creating a new DB instance.
Some characteristics of the new DB instance can be modified using optional parameters; if these are
omitted, the new DB instance defaults to the characteristics of the DB instance from which the DB
snapshot was created.
Note
This operation is not supported for Read Replica DB instances.
Syntax
rds-restore-db-instance-to-point-in-time target-db-instance-identifier
-s (--source-db-instance-identifier) value
[-l (--use-latest-restorable-time) ]
[-e (--engine) value ]
[-lm (--license model) value ]
[-r (--restore-time) value ]
[-z (--availability-zone) value ]
[-c (--db-instance-class) value ]
[-ct (--copy-tags-to-snapshot) value ]
[-p (--port) value ]
[-st (--storage-type) value ]
[--iops value ]
[-og (--option-group) value]
[-pub (--publicly-accessible) value]
API Version 2014-10-31
163
Amazon Relational Database Service
Command Line Interface Reference
Options
[-m (--multi-az) value]
[-au (--auto-minor-version-upgrade) value ]
[-n (--db-name) value ]
[-sn (--db-subnet-group-name) value ]
[-tca (--tde-credential-arn) value ]
[-tcp (--tde-credential-password) value ]
[-tk (--tag-key) value ]
[-tv (--tag-value) value ]
[General Options]
Options
Name
Description
Required
-t value
DB instance identifier. This is the unique key that
identifies a DB instance.
Yes
--target-db-instance-identifier
value
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsrestore-db-instance-to-point-in-time mytarget-db-instance-identifier.
Type: String
Default: None
Constraints: Must contain 1 to 63 alphanumeric
characters or hyphens. First character must be a
letter. Cannot end with a hyphen or contain two
consecutive hyphens.
Example: mydbinstance
-s value
--source-db-instance-identifier
value
-l
--use-latest-restorable-time
User-supplied identifier of the DB instance from
which to restore. This instance must be available
and must have automated backups enabled.
Yes
Type: String
Specifies that the DB instance is restored from the
latest backup time.
Conditional
Type: Boolean
Default: False
Constraints: Cannot be specified if RestoreTime
parameter is provided.
-lm
License model for the new DB instance.
--license-model value
Type: String
API Version 2014-10-31
164
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
Default: Same as the source DB instance.
Valid values: license-included | bring-your-ownlicense | general-public-license
Example: --license-model bring-your-own
-r value
The date and time from to restore from.
--restore-time value
Type: Date
Conditional
Default: none
Valid Values: Value must be a UTC time
Constraints:
• Time specified must be after the creation of the
oldest system snapshot available for sourcedb-instance-identifier.
• Cannot be after the latest restorable time for
the DB instance.
• Cannot be specified if use-latest-restorabletime parameter is true.
Example: 2009-09-07T23:45:00Z
-z value
--availability-zone value
The Amazon EC2 Availability Zone that the DB
instance will be created in.
Type: String
Default: The Availability Zone of the source DB
instance.
Example: -z us-east-1c
API Version 2014-10-31
165
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-c value
Contains the compute and memory capacity of
the DB instance.
No
--db-instance-class value
Type: String
Default: The instance class of the source DB
instance. Different instance classes are available
for different database engines. For information
about valid values for a particular engine, use
the rds-describe-orderable-db-instanceoptions (p. 109) command.
Valid values: db.t1.micro | db.m1.small |
db.m1.medium | db.m1.large | db.m1.xlarge |
db.m2.2xlarge | db.m2.4xlarge | db.m3.medium
| db.m3.large | db.m3.xlarge | db.m3.2xlarge
| db.r3.large | db.r3.xlarge | db.r3.2xlarge
| db.r3.4xlarge | db.r3.8xlarge | db.t2.micro
| db.t2.small | db.t2.medium | db.t2.large |
db.m4.large | db.m4.xlarge | db.m4.2xlarge |
db.m4.4xlarge | db.m4.10xlarge
Example: --db-instance-class db.m1.xlarge
Example: --db-instance-class db.m1.xlarge
--copy-tags-to-snapshot
-ct
-e value
--engine value
True to copy all tags from the restored DB
instance to snapshots of the DB instance;
otherwise false. The default is false.
No
Name of the database engine to use for the new
DB instance.
No
Type: String
Default: Same as the source DB instance.
Valid values: MySQL | oracle-se1 | oracle-se |
oracle-ee
-p value
--port value
Port number that the DB instance uses for
connections.
Type: Integer
Default: The value used in the DB snapshot
Example: --port 1234
API Version 2014-10-31
166
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-st value
Specifies the storage type for the DB instance.
No
--storage-type value
Type: String
Valid values: standard | gp2 | io1.
Default: io1 if the --iops parameter is specified;
otherwise standard
If you specify io1, you must also include a value
for the --iops parameter.
--iops value
Specifies the amount of provisioned IOPS for
the DB instance, expressed in I/O operations per
second.
No
If this parameter is not specified, the IOPS value
will be taken from the original instance. If this
parameter is set to 0, the new instance will not
have provisioned IOPS.
Constraints: Must be an integer greater than
1000.
SQL Server
You cannot change the provisioned IOPS for a
SQL Server DB instance.
-pub value
--publicly-accessible value
Specifies the accessibility options for the DB
instance. A value of true specifies an Internetfacing instance with a publicly resolvable DNS
name, which resolves to a public IP address. A
value of false specifies an internal instance with a
DNS name that resolves to a private IP address.
No
If you change this setting from true to false, you
break any connections to the DB instance that are
using the public IP address.
-m value
--multi-az value
Specifies if the new DB instance is a Multi-AZ
deployment. Not a valid option for SQL Server
Multi-AZ mirrored instances. To configure MultiAZ for a SQL Server instance, apply or remove the
"Mirroring" option using Option Groups.
Type: Boolean
Default: false
Valid values: true | false
Constraints: The --availability-zone parameter
cannot be set if the --multi-az parameter is set
to true.
API Version 2014-10-31
167
No
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-og value
Specifies the name of the option group that
should be associated with the restored instance.
No
--option-group value
Permanent options, such as the TDE option for
Oracle Advanced Security TDE, can never 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.
Type: String
API Version 2014-10-31
168
Amazon Relational Database Service
Command Line Interface Reference
Options
Name
Description
Required
-n value
The meaning of this parameter differs according
to the database engine you use.
No
--db-name value
MySQL
Name of a database to create when the DB
instance is created. If this parameter is not
specified, no database is created in the instance.
Constraints:
• Cannot be empty.
• Must contain 1 to 64 alphanumeric characters.
• Cannot be a word reserved by the specified
database engine.
Type: String
Example: --db-name MyDatabase
PostgreSQL
Name of a database to create when the DB
instance is created. If this parameter is not
specified, the default "postgres" database is
created on the instance.
Constraints:
• Must contain 1 to 63 alphanumeric characters.
• Cannot be a word reserved by the specified
database engine.
Type: String
Example: --db-name pgDatabase
Oracle
The Oracle System ID (SID) of the created DB
instance.
Constraints:
• Cannot be longer than 8 characters.
Type: String
Example: --db-name MYORACLE
SQL Server
Not applicable.
API Version 2014-10-31
169
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-au value
Indicates that minor version upgrades will be
applied automatically to the DB instance during
the maintenance window.
No
--auto-minor-version-upgrade
value
Type: Boolean
Example: --au true
The name of the DB subnet group to restore into.
Specifying a DB subnet group will restore to a DB
instance in the named VPC.
-sn value
--db-subnet-group-name value
No
Note
You can restore a DB instance from a VPC
to a DB instance in another VPC, or from
a non-VPC DB instance into a DB instance
in a VPC. You cannot restore from a VPC
to a DB instance that is not in a VPC.
Type: String
Default: none
Constraints: Must be the name of an existing DB
subnet group.
Example: --db-subnet-group-name
mydbsubnetgroup
-tca value
--tde-credential-arn value
-tcp value
--tde-credential-password value
--tag-key
-tk
--tag-value
-tv
The ARN of the HSM HA Partition Group used for
the TDE HSM option.
No
The password of the HSM HA Partition Group
used for the TDE HSM option.
No
The name of a tag to add for the restored DB
instance.
No
The value of the tag to add for the restored DB
instance.
No
Output
The command returns a table that contains the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• DBInstanceID—the user-supplied database identifier
API Version 2014-10-31
170
Amazon Relational Database Service
Command Line Interface Reference
Output
• Created—the data and time the instance was created, in UTC
• Class—The compute and memory capacity of the instance
• CopyTagsToSnapshot—Specifies whether tags are copied from the DB instance to snapshots 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
• Storage Type—The type of storage specified
• Iops—The provisioned storage IOPS, expressed as I/O operations per second
• Storage Encrypted—Indicates whether the DB instance is encrypted
• KmsKeyId—If Storage Encrypted is true, the KMS key identifier for the encrypted DB instance
• Resource Id—If Storage Encrypted is true, the region-unique, immutable identifier for the encrypted
DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB
instance is accessed.
• 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-credentials
• SecondaryAvailabilityZone—If present, specifies the name of the secondary Availability Zone for a DB
instance with multi-AZ support.
• 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.
• PendingBackupRetention—The backup retention period which will be applied at the next
maintenance window, or which is currently being applied if the --apply-immediately option was
specified.
• 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.
• PendingStorage—The storage size 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.
• DB Name—Name of the initial database created when the instance was created. This column appears
only in the --show-long view.
• Maintenance Window—The window during which patching and instance modifications will be
performed. This column appears only in the --show-long view.
• Backup Window—The period during which daily automated backups are created. This column appears
only in the --show-long view.
• Name—security group name.
• Status—Status of authorization. Valid values: authorizing | authorized | revoking
• Name—DB subnet group name.
• Description—DB subnet group description.
• Group Name—Name of DB parameter group applied to.
• Apply Status—Status of applying the parameter group. It can be either in-sync or pending-reboot.
• Multi-AZ—Indicates if this is a Multi-AZ DB instance.
• EngineVersion—Database engine version number.
API Version 2014-10-31
171
Amazon Relational Database Service
Command Line Interface Reference
Examples
Examples
Restore a Database to a Specified Time with Minimal Parameters
This example restores a database to a specified time with the minimal set of parameters.
PROMPT> rds-restore-db-instance-to-point-in-time restored-db -s original-db -r
2009-07-31T13:00:00Z
Restore a Database to a Specified Time, Specifying a New
Availability Zone
This example restores a database to a specified time with a new Availability Zone.
PROMPT> rds-restore-db-instance-to-point-in-time restored-db -s original-db -r
2009-07-31T13:00:00Z -z us-east-1b
Related Operations
• rds-create-db-instance (p. 31)
• rds-describe-db-instances (p. 81)
rds-revoke-db-security-group-ingress
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Revokes ingress to a DB security group for previously authorized IP ranges or Amazon EC2 security
groups.
Syntax
rds-revoke-db-security-group-ingress DBSecurityGroupName
[-s (--ec2-security-group-id) ] value
API Version 2014-10-31
172
Amazon Relational Database Service
Command Line Interface Reference
Options
[-g (--ec2-security-group-name) ] value
[-i (--cidr-ip) value ]
[-o (--ec2-security-group-owner-id) value ]
[General Options]
Options
Name
Description
Required
--db-security-group-name value
The name of the DB security group.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsrevoke-db-security-group-ingress my-dbsecurity-group-name.
Type: String
Default: None
Example: --db-security-group-name
mydbsecuritygroup
Identifier of the Amazon EC2 security group to
authorize.
-s
--ec2-security-group-id value
No
Type: String
Default: None
Constraints: This parameter must be specified if
the DB security group is for a VPC.
Example: -g myec2securitygroup
-g
The name of the Amazon EC2 security group.
--ec2-security-group-name value
Type: String
No
Default: None
Example: -g myec2securitygroup
-i
The IP range to allow access.
--cidr-ip-value value
Type: String
Constraints: Must be a valid Classless InterDomain Routing (CIDR) range, in the format
ddd.ddd.ddd.ddd/dd. For more information, see
CIDR Notation.
Default: None
Example: -i 192.168.100.100/0
API Version 2014-10-31
173
No
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
-o
AWS Account Number for the owner of the EC2
security group. Note that this is the account
number, not the AWS Access ID.
No
--ec2-security-group-owner-id
value
Type: String
Default: None
Example: -o 3454903478548345
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Name—the security group name
• Description—the security group description
• EC2 Group Name—the name of the Amazon EC2 security group
• EC2 Group Id—Identifier of the Amazon EC2 security group
• EC2 Owner ID—the owner of the Amazon EC2 security group
• IP Range—the CIDR range for the authorized Amazon RDS DB security group
• Status—the status of the authorization
Examples
Authorizing Access to an Amazon EC2 Security Group
This example revokes authorization for an IP range
PROMPT> rds-revoke-db-security-group-ingress Default --cidr-ip 192.168.100.100/0
Authorizing Access to a CIDR range
This example revokes authorization for an Amazon EC2 security group.
PROMPT> rds-revoke-db-security-group-ingress Default --ec2-security-group-name secgrp -owner-id 666666666666
API Version 2014-10-31
174
Amazon Relational Database Service
Command Line Interface Reference
Related Operations
Related Operations
• rds-authorize-db-security-group-ingress (p. 20)
• rds-describe-db-security-groups (p. 90)
• rds-create-db-security-group (p. 58)
• rds-delete-db-security-group (p. 74)
rds-watch-db-logfile
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-fileportion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Monitors a database log file and constantly polls to retrieve the most recent log file contents.
Syntax
rds-watch-db-logfile db-instance-identifier
--log-file-name value
[General Options]
Options
Name
Description
Required
db-instance-identifier
value
DB instance identifier. This is the unique key that
identifies a DB instance. This parameter is stored as a
lowercase string.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rds-watchdb-logfile my-db-instance-identifier.
Type: String
--log-file-name
The name of the log file to be downloaded.
Type: String
Output
The command the last line written to the specified log file.
API Version 2014-10-31
175
Yes
Amazon Relational Database Service
Command Line Interface Reference
Examples
Examples
Watches a Log File
This example monitors a log file named error-running.log.20 for the DB instance named mysql-db1.
PROMPT> rds-watch-db-logfile mysql-db1 --log-file-name error-running.log.20
Related Operations
• rds-download-db-logfile (p. 118)
rds-update-option-in-option-group
Description
Updates the configuration of an option in a specific option group.
Syntax
rds-update-option-in-option-group option-group-name
--option-name value
[--apply-immediately]
[--security-groups value[,value2][,...]]
[--settings key1=value1;key2=value2;...]
[--port value]
[General Options]
Options
Name
Description
Required
--option-group-name value
The option group that the option belongs to.
Yes
This parameter is the default parameter and can
be passed as the first value in the command and
without a parameter name, for example: rdsupdate-option-in-option-group my-optiongroup-name.
--option-name
-n
Name of the option to be updated into the option
group.
API Version 2014-10-31
176
Yes
Amazon Relational Database Service
Command Line Interface Reference
Output
Name
Description
Required
--security-groups
Name of the security group or groups that will
be applied to the port that the option uses for
communication.
Yes if the
option
uses a
port;
otherwise,
no.
--apply-immediately
If supplied, the option will be applied immediately
for all associated DB instances. If not supplied, the
option will be applied for each DB instance during
its next maintenance window.
No
--settings
A list of option settings to apply to the option
as a semi-colon separated list in the form
'key1=value1; mey2=value2; etc. If no settings
are provided for an option that requires one, the
default values will be used.
No
A non-default port that the option will use for
communication.
No
-sg
-s
--port
Output
The command returns a table with the following information:
Note
Output values list the possible values returned by CLI commands. Not all values are returned
for every call to a command. If a value is null or empty, it will not be included in the command
output. For example, CLI commands to create or restore a DB instance will not return the
Endpoint Address value because that value is null until the DB instance has finished being
created or restored.
• Group name—The name of the option group.
• Engine—The name of the DB engine that the option group is associated with.
• Major engine version—The major version ID of the DB engine.
• Option group description—The description of the option group.
• Option name—The name of the option that was added.
• Port—The number of the port that the option will use.
• Persistent—Indicates if this is a persistent option. A persistent option cannot be removed from the
option group once the option group is used, but this option can be removed from the db instance
while modifying the related data and assigning another option group without this option.
• Permanent—Indicates if this is a permanent option. A permanent option cannot be removed from
the option group once the option group is used, and it cannot be removed from the db instance after
assigning an option group with this permanent option.
• Option description—A description of the option.
• Option status—The status of authorization.
• Security group—The security group assigned to the port.
• Authorization—Status of ingress authorization for the security group.
• VPC Specific—Indicates if both VPC and non-VPC instances can join this option group.
• VPC—Indicates if only instances in this VPC can join this option group.
API Version 2014-10-31
177
Amazon Relational Database Service
Command Line Interface Reference
Example
• Setting—The setting name that the option will use.
• Setting Description—The description of the option setting.
• Value—The value of the option setting.
• Modifiable—Indicates if the option setting is modifiable.
Example
This example updates settings of an option in the option group. If no settings are specified, default
values for the settings are applied.
PROMPT> rds-update-option-in-option-group my-option-group -n NATIVE_NETWORK_ENCRYPTION -settings "SQLNET.ENCRYPTION_SERVER=REQUIRED; SQLNET.ENCRYPTION_TYPES_
SERVER=AES256,AES192,DES"
OPTIONGROUP Group Name
Engine
Major Engine Version Description
VpcSpecific
OPTIONGROUP my-option-group oracle-ee 11.2
My option group n
OPTION Name
Persistent Permanent Description
OPTION NATIVE_NETWORK_ENCRYPTION
n
n
Oracle Advanced Security Native Network Encryption
OPTIONSETTING Name
Description
Value
Modifiable
OPTIONSETTING SQLNET.CRYPTO_CHECKSUM_TYPES_SERVER Specifies list of checksumming
algorithms in order of intended use SHA1,MD5
true
OPTIONSETTING SQLNET.ENCRYPTION_TYPES_SERVER
Specifies list of encryption
algorithms in order of intended use
AES256,AES192,DES true
OPTIONSETTING SQLNET.ENCRYPTION_SERVER
Specifies the desired encryption
behavior
REQUIRED
true
OPTIONSETTING SQLNET.CRYPTO_CHECKSUM_SERVER
Specifies the desired data
integrity behavior
REQUESTED
true
This example updates the port used by an option already in an option group and overwrites the security
groups already in use for the option.
PROMPT> rds-update-option-in-option-group my-option-group -n OEM --port 5432 -sg default
OPTIONGROUP my-option-group oracle-se 11.2 My option group
OPTION OEM n 5432 Oracle Enterprise Manager
SECGROUP default authorized
rds-version
The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS
CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface
User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon
RDS.
The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To
download an entire log file at once, rather than in parts using the download-db-log-file-
API Version 2014-10-31
178
Amazon Relational Database Service
Command Line Interface Reference
Description
portion command, use the last published RDS CLI and the rds-download-db-logfile (p. 118)
command.
Description
Returns the current version of the Amazon RDS Command Line Interface.
Syntax
rds-version
Options
None.
Output
This command returns a string containing the version of the Amazon RDS Command Line Interface.
Examples
Example Request
This example returns the version of the Amazon RDS Command Line Interface.
PROMPT>rds-version
Relational Database Service CLI version 1.2.000 (API 2010-06-28)
Related Operations
• List of Command Line Operations by Function (p. 11)
API Version 2014-10-31
179
Amazon Relational Database Service
Command Line Interface Reference
Document History
The following table describes the important changes to the documentation since the last release of the
Amazon Relational Database Service Command Line Reference.
• API version: 2014-10-31
• Latest documentation update: January 7, 2016
Change
Description
Date Changed
RDS CLI Deprecated
The Amazon RDS Command Line Interface (CLI) has
been deprecated. Instead, use the AWS AWS CLI for
RDS.
January 7, 2016
For information on how to download and use the AWS
CLI, go to AWS Command Line Interface User Guide. For a
reference of the RDS commands available in the AWS CLI,
go to AWS CLI Reference for Amazon RDS.
New feature
Updated to support Microsoft SQL Server 2014 for the
Web, Express, and Standard editions.
October 26, 2015
New feature
Updated to support db.t2 burst-capable DB instance
classes for all DB engines and the addition of the
db.t2.large DB instance class.
September 25, 2015
New feature
Updated to support copying tags to DB snapshots.
July 20, 2015
New feature
Updated to support Oracle 12c database version
"12.1.0.2", including the In-Memory option, Oracle 11g
April PSU patches, and improved integration with AWS
CloudHSM.
July 20, 2015
New feature
Updated to support increases in storage size for all DB
engines and an increase in Provisioned IOPS for SQL
Server.
June 18, 2015
New feature
Updated to support Oracle version 12c.
April 2, 2015
New feature
Updated to support PostgreSQL versions 9.3.6 and 9.4.1.
March 18, 2015
API Version 2014-10-31
180
Amazon Relational Database Service
Command Line Interface Reference
Change
Description
Date Changed
New feature
Updated to support using Amazon CloudHSM with Oracle
DB instances using TDE.
January 8, 2015
New feature
Updated to support encrypting data at rest and new API
version 2014-10-31.
January 6, 2015
New feature
Updated to support Oracle versions 11.2.0.3.v2 and
11.2.0.4.v3 that include the PSU released in October
2014.
November 20, 2014
New feature
Updated to support PostgreSQL Read Replicas.
November 10, 2014
New features
Updated to support Oracle 11.2.0.4v2.
October 16, 2014
New API and
features
Updated to support the GP2 storage type and new API
version 2014-09-01. Updated to support the ability to
copy an existing option or parameter group to create a
new option or parameter group.
October 7, 2014
New feature
Updated to support the db.t2 burst-capable DB instance
classes.
August 4, 2014
New feature
Updated to support the db.r3 memory-optimized DB
instance classes for use with the MySQL (version 5.6), SQL
Server, and PostgreSQL database engines.
May 28, 2014
New feature
Updated to support SQL Server Multi-AZ deployments
using SQL Server Mirroring.
May 19, 2014
New feature
Updated to support upgrades from MySQL version 5.5 to
version 5.6.
April 23, 2014
New feature
Updated to support Oracle 11.2.0.4.
April 23, 2014
New feature
Updated to support Oracle GoldenGate.
April 3, 2014
New feature
Updated to support the M3 DB instance classes.
February 20, 2014
New feature
Updated to support the Oracle Timezone option.
January 13, 2014
New feature
Updated to support Oracle 11.2.0.3.v1.
December 16, 2013
New feature
Updated to support replication between Amazon RDS
MySQL DB instances in different regions.
November 26, 2013
New feature
Updated to support the PostgreSQL DB engine.
November 14, 2013
New feature
Updated to support SQL Server transparent data
encryption (TDE).
November 7, 2013
New API and new
feature
Updated to support cross region DB snapshot copy; new
API version, 2013-09-09
October 31, 2013
New feature
Updated to support replication of replicas.
September 24, 2013
New feature
Updated to support fine-grained permissions and tagging
for all Amazon RDS resources.
July 8, 2013
API Version 2014-10-31
181
Amazon Relational Database Service
Command Line Interface Reference
Change
Description
Date Changed
New API and new
feature
Updated to support Read Replica status; new API version,
2013-05-15
May 23, 2013
New features
Updated to support Oracle Advanced Security features
for native network encryption and transparent data
encryption.
April 18, 2013
New features
Updated to support major version upgrades for SQL
Server and additional functionality for Provisioned IOPS.
March 13, 2013
New feature
Updated to support VPC By Default for Amazon RDS.
March 11, 2013
New API and new
feature
Updated to support database log access; new API version,
2013-02-12
March 4, 2013
New feature
Updated to support Amazon RDS event notification
subscriptions.
February 4, 2013
New API and new
feature
Updated to support DB instance renaming and the
migration of DB security group members in a VPC to a
VPC security group.
January 14, 2013
New feature
Updated to support m1.medium and m1.xlarge DB
Instance classes.
November 6, 2012
New feature
Updated to support Read Replica promotion.
October 11, 2012
New API and
features
Updated to support Provisioned IOPS. API version
2012-09-17.
September 20, 2012
New features
Updated to support resource tagging.
August 8, 2012
New features
Updated to support option groups. First option group
supported is Oracle Enterprise Manager Database
Control.
May 29, 2012
New features
Updated for Microsoft SQL Server support.
May 8, 2012
New features
Updated for support for forced failover, Multi-AZ
deployment for Oracle DB Instances, and nondefault
character sets for Oracle DB Instances
May 2, 2012
New feature
Updated for Amazon Virtual Private Cloud (VPC) Support.
March 16, 2012
Updated content
Updated for new Reserved Instance types.
December 19, 2011
New feature
Adds support for new Reserved DB Instance types.
December 29, 2011
New feature
Added support for the Oracle database engine.
May 23, 2011
New feature
Added support for MySQL 5.5.
January 11, 2011
New feature
Added support for Read Replicas.
October 4, 2010
New feature
Added support for DB Engine Version Management.
August 16, 2010
New feature
Added support for Reserved DB Instances.
August 16, 2010
API Version 2014-10-31
182
Amazon Relational Database Service
Command Line Interface Reference
Change
Description
Date Changed
New feature
Added command line arguments for new Multi-AZ
deployment feature.
May 17, 2010
Added content
Added new --region common parameter.
April 13, 2010
New Service
This is the first release of Amazon Relational Database
Service Command Line Reference. Future updates and
changes will be noted here.
October 26, 2009
API Version 2014-10-31
183