Skip to main content

db_parameter_groups_list_only

Lists db_parameter_groups in a region or regions, for all properties use db_parameter_groups

Overview

Namedb_parameter_groups_list_only
TypeResource
DescriptionThe AWS::RDS::DBParameterGroup resource creates a custom parameter group for an RDS database family.
This type can be declared in a template and referenced in the DBParameterGroupName property of an AWS::RDS::DBInstance resource.
For information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
For information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.
Idaws.rds.db_parameter_groups_list_only

Fields

NameDatatypeDescription
db_parameter_group_namestringThe name of the DB parameter group.
Constraints:
+ Must be 1 to 255 letters, numbers, or hyphens.
+ First character must be a letter
+ Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group.
This value is stored as a lowercase string.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all db_parameter_groups in a region.

SELECT
region,
db_parameter_group_name
FROM aws.rds.db_parameter_groups_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the db_parameter_groups_list_only resource, see db_parameter_groups