Skip to content

Resource: awsRdsClusterParameterGroup

Provides an RDS DB cluster parameter group resource. Documentation of the available parameters for various Aurora engines can be found at:

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.rdsClusterParameterGroup.RdsClusterParameterGroup(this, "default", {
  description: "RDS default cluster parameter group",
  family: "aurora5.6",
  name: "rds-cluster-pg",
  parameter: [
    {
      name: "character_set_server",
      value: "utf8",
    },
    {
      name: "character_set_client",
      value: "utf8",
    },
  ],
});

Argument Reference

The following arguments are supported:

  • name - (Optional, Forces new resource) The name of the DB cluster parameter group. If omitted, Terraform will assign a random, unique name.
  • namePrefix - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with name.
  • family - (Required) The family of the DB cluster parameter group.
  • description - (Optional) The description of the DB cluster parameter group. Defaults to "Managed by Terraform".
  • parameter - (Optional) A list of DB parameters to apply. Note that parameters may differ from a family to an other. Full list of all parameters can be discovered via awsRdsDescribeDbClusterParameters after initial creation of the group.
  • tags - (Optional) A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Parameter blocks support the following:

  • name - (Required) The name of the DB parameter.
  • value - (Required) The value of the DB parameter.
  • applyMethod - (Optional) "immediate" (default), or "pending-reboot". Some engines can't apply some parameters without a reboot, and you will need to specify "pending-reboot" here.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The db cluster parameter group name.
  • arn - The ARN of the db cluster parameter group.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Import

RDS Cluster Parameter Groups can be imported using the name, e.g.,

$ terraform import aws_rds_cluster_parameter_group.cluster_pg production-pg-1