Amazon Relational Database Service
Command Line Interface Reference (API Version 2014-10-31)


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-portion command, use the last published RDS CLI and the rds-download-db-logfile command.


Creates a new DB subnet group.


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]


Name Description Required

--db-subnet-group-name value

-n value

The name for the DB subnet group. This value is stored as a lowercase string.

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-subnet-group my-db-subnet-group-name.

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-group-description value

-d value

The description for the database subnet group.

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.

Type: String

Default: None

Constraints: Must be existing subnets.

Example: -s subnet1, subnet2




The name of a tag to add for the new DB subnet group.




The value of the tag to add for the new DB subnet group.



The command returns the following information:


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

  • 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


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-group-description "My Subnet Group" --db-subnet-list subnet1, subnet2, subnet3