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

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

DB parameter 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-parameters my-db-parameter-group-name.

Type: String

Default: None

Yes

--source value

Specifies which parameter types to return.

Type: String

Default: None

Valid values: user | system | engine-default

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.

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

Copy
PROMPT> rds-describe-db-parameters mydbparamgrp --headers CONFIGPARAMETERS Parameter Name Parameter Value Description Source Apply Type Is Modifiable CONFIGPARAMETERS max_allowed_packet 2M The largest possible packet that can ... user dynamic true CONFIGPARAMETERS log-error /rdsdblog/error/m...specify where mysqld writes the error... engine-default static false