rds-describe-db-parameters

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 DBParameterGroupName

[--max-records value ] [--source value ] [General Options]

Options

Name Description Required

Name	Description	Required
`DBParameterGroupName`	DB Parameter Group name. This value can also be supplied using the `--db-parameter-group-name` parameter. Type: String Default: None	Yes
`--source` `value`	Specifies which parameter types to return. Type: String Default: None Valid values: `user` \| `system` \| `engine-default`	No

DBParameterGroupName

DB Parameter Group name. This value can also be supplied using the --db-parameter-group-name parameter.

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:

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