db_parameter_groups

Creates, updates, deletes or gets a db_parameter_group resource or lists db_parameter_groups in a region

Overview

Name	db_parameter_groups
Type	Resource
Description	The 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.
Id	aws.rds.db_parameter_groups

Fields

Name	Datatype	Description
db_parameter_group_name	string	The 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.
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. The DB parameter group family can't be changed when updating a DB parameter group. To list all of the available parameter group families, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" The output contains duplicates. 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. 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. 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*. 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*. AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
tags	array	An optional array of key-value pairs to apply to this DB parameter group. Currently, this is the only property that supports drift detection.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Family, Description, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all db_parameter_groups in a region.

SELECT
region,
db_parameter_group_name,
description,
family,
parameters,
tags
FROM aws.rds.db_parameter_groups
WHERE region = 'us-east-1';

Gets all properties from an individual db_parameter_group.

SELECT
region,
db_parameter_group_name,
description,
family,
parameters,
tags
FROM aws.rds.db_parameter_groups
WHERE region = 'us-east-1' AND data__Identifier = '<DBParameterGroupName>';

INSERT example

Use the following StackQL query and manifest file to create a new db_parameter_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.rds.db_parameter_groups (
 Description,
 Family,
 region
)
SELECT 
'{{ Description }}',
 '{{ Family }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.rds.db_parameter_groups (
 DBParameterGroupName,
 Description,
 Family,
 Parameters,
 Tags,
 region
)
SELECT 
 '{{ DBParameterGroupName }}',
 '{{ Description }}',
 '{{ Family }}',
 '{{ Parameters }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: db_parameter_group
    props:
      - name: DBParameterGroupName
        value: '{{ DBParameterGroupName }}'
      - name: Description
        value: '{{ Description }}'
      - name: Family
        value: '{{ Family }}'
      - name: Parameters
        value: {}
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.rds.db_parameter_groups
WHERE data__Identifier = '<DBParameterGroupName>'
AND region = 'us-east-1';

Permissions

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

Create

iam:CreateServiceLinkedRole,
rds:AddTagsToResource,
rds:CreateDBParameterGroup,
rds:DescribeDBParameterGroups,
rds:DescribeDBParameters,
rds:DescribeEngineDefaultParameters,
rds:ListTagsForResource,
rds:ModifyDBParameterGroup,
rds:RemoveTagsFromResource

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

List

rds:DescribeDBParameterGroups