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

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

Contains the name of the DB parameter group family for which to list defaults.

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-engine-default-parameters my-db-parameter-group-family.

Type: String

Default: None

Yes

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.

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

Copy
PROMPT> rds-describe-engine-default-parameters MySQL5.1 --headers