Skip to main content

db_parameter_group_tags

Expands all tag keys and values for db_parameter_groups in a region

Overview

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

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.
descriptionstringProvides the customer-specified description for this DB parameter group.
familystringThe DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
The output contains duplicates.
The following are the valid DB engine values:
+ aurora-mysql
+ aurora-postgresql
+ db2-ae
+ db2-se
+ mysql
+ oracle-ee
+ oracle-ee-cdb
+ oracle-se2
+ oracle-se2-cdb
+ postgres
+ sqlserver-ee
+ sqlserver-se
+ sqlserver-ex
+ sqlserver-web
parametersobjectAn array of parameter names and values for the parameter update. You must specify at least one parameter name and value.
For more information about parameter groups, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all db_parameter_groups in a region.

SELECT
region,
db_parameter_group_name,
description,
family,
parameters,
tag_key,
tag_value
FROM aws.rds.db_parameter_group_tags
WHERE region = 'us-east-1';

Permissions

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