Skip to content

Resource: awsDocdbClusterParameterGroup

Manages a DocumentDB Cluster Parameter Group

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.docdbClusterParameterGroup.DocdbClusterParameterGroup(this, "example", {
  description: "docdb cluster parameter group",
  family: "docdb3.6",
  name: "example",
  parameter: [
    {
      name: "tls",
      value: "enabled",
    },
  ],
});

Argument Reference

The following arguments are supported:

  • name - (Optional, Forces new resource) The name of the documentDB 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, Forces new resource) The family of the documentDB cluster parameter group.
  • description - (Optional, Forces new resource) The description of the documentDB cluster parameter group. Defaults to "Managed by Terraform".
  • parameter - (Optional) A list of documentDB parameters to apply. Setting parameters to system default values may show a difference on imported resources.
  • 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:

\~> NOTE: These arguments take a string representation of their values.

  • name - (Required) The name of the documentDB parameter.
  • value - (Required) The value of the documentDB parameter.
  • applyMethod - (Optional) Valid values are immediate and pendingReboot. Defaults to pendingReboot.

Attributes Reference

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

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

Import

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

$ terraform import aws_docdb_cluster_parameter_group.cluster_pg production-pg-1