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 in the Amazon RDS User Guide.
For information about configuring parameters for Amazon Aurora DB instances, see Working with parameter groups 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.
To create a simple db parameter group
resource "awscc_rds_db_parameter_group" "this" {
description = "rds sample db parameter group"
family = "mysql5.6"
parameters = {
"character_set_server" = "utf8"
"character_set_client" = "utf8"
}
}
To create a db parameter group with tags
resource "awscc_rds_db_parameter_group" "this" {
description = "rds sample db parameter group"
family = "mysql5.6"
parameters = {
"character_set_server" = "utf8"
"character_set_client" = "utf8"
}
tags = [{
key = "Name"
value = "this"
}]
}
create_before_destroy
Lifecycle Configuration.To create a db parameter group with create_before_destroy
Lifecycle Configuration example
resource "awscc_rds_db_parameter_group" "this" {
description = "rds sample db parameter group"
family = "mysql5.7"
parameters = {
"character_set_server" = "utf8"
"character_set_client" = "utf8"
}
lifecycle {
create_before_destroy = true
}
}
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
.db_parameter_group_name
(String) The name of the DB parameter group.
Constraints:
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.
parameters
(String) 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 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 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
(Attributes List) An optional array of key-value pairs to apply to this DB parameter group.
Currently, this is the only property that supports drift detection. (see below for nested schema)id
(String) Uniquely identifies the resource.tags
Required:
key
(String) A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws:
or rds:
. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").Optional:
value
(String) A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws:
or rds:
. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").Import is supported using the following syntax:
$ terraform import awscc_rds_db_parameter_group.example <resource ID>