db_parameter_group

Gets an individual db_parameter_group resource

Overview

Name	db_parameter_group
Type	Resource
Description	db_parameter_group
Id	awscc.rds.db_parameter_group

Fields

Name	Datatype	Description
db_parameter_group_name	string	The name of the DB parameter group.<br/> Constraints:<br/> + Must be 1 to 255 letters, numbers, or hyphens.<br/> + First character must be a letter<br/> + Can't end with a hyphen or contain two consecutive hyphens<br/> <br/> If you don't specify a value for ``DBParameterGroupName`` property, a name is automatically created for the DB parameter group.<br/> This value is stored as a lowercase string.
description	string	Provides the customer-specified description for this DB parameter group.
family	string	The 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 DB engine and engine version compatible with that DB parameter group family.<br/> The DB parameter group family can't be changed when updating a DB parameter group.<br/> To list all of the available parameter group families, use the following command:<br/> ``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"``<br/> The output contains duplicates.<br/> For more information, see ``CreateDBParameterGroup``.
parameters	object	An array of parameter names and values for the parameter update. At least one parameter name and value must be supplied. Subsequent arguments are optional.<br/> RDS for Db2 requires you to bring your own Db2 license. You must enter your IBM customer ID (``rds.ibm_customer_id``) and site number (``rds.ibm_site_id``) before starting a Db2 instance.<br/> For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.<br/> For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.<br/> AWS CloudFormation doesn't support specifying an apply method for each individual
tags	array	An optional array of key-value pairs to apply to this DB parameter group.<br/> Currently, this is the only property that supports drift detection.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
db_parameter_group_name,
description,
family,
parameters,
tags
FROM awscc.rds.db_parameter_group
WHERE data__Identifier = '<DBParameterGroupName>';

Permissions

To operate on the db_parameter_group resource, the following permissions are required:

Read

rds:DescribeDBParameterGroups,
rds:DescribeDBParameters,
rds:DescribeEngineDefaultParameters,
rds:ListTagsForResource

Update

rds:AddTagsToResource,
rds:DescribeDBParameterGroups,
rds:DescribeDBParameters,
rds:DescribeEngineDefaultParameters,
rds:ListTagsForResource,
rds:ModifyDBParameterGroup,
rds:ResetDBParameterGroup,
rds:RemoveTagsFromResource

Delete

rds:DeleteDBParameterGroup