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

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

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

Type: String

Default: None

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—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.

Copy
PROMPT> rds-describe-db-subnet-groups -H SUBNETGROUP Name Description Status SUBNETGROUP mygroup my group desc Active SUBNET Subnet Identifier Subnet Availability Zone Status SUBNET mytestgroup us-east-1c Active