Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. DbClusterParameterGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.DbClusterParameterGroup

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For information about configuring parameters for Amazon Aurora DB clusters, see Working with parameter groups in the Amazon Aurora User Guide. If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.

Create DbClusterParameterGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DbClusterParameterGroup(name: string, args: DbClusterParameterGroupArgs, opts?: CustomResourceOptions);
@overload
def DbClusterParameterGroup(resource_name: str,
                            args: DbClusterParameterGroupArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def DbClusterParameterGroup(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            description: Optional[str] = None,
                            family: Optional[str] = None,
                            parameters: Optional[Any] = None,
                            db_cluster_parameter_group_name: Optional[str] = None,
                            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewDbClusterParameterGroup(ctx *Context, name string, args DbClusterParameterGroupArgs, opts ...ResourceOption) (*DbClusterParameterGroup, error)
public DbClusterParameterGroup(string name, DbClusterParameterGroupArgs args, CustomResourceOptions? opts = null)
public DbClusterParameterGroup(String name, DbClusterParameterGroupArgs args)
public DbClusterParameterGroup(String name, DbClusterParameterGroupArgs args, CustomResourceOptions options)

type: aws-native:rds:DbClusterParameterGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DbClusterParameterGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DbClusterParameterGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DbClusterParameterGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DbClusterParameterGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DbClusterParameterGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DbClusterParameterGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DbClusterParameterGroup resource accepts the following input properties:

Description This property is required. string
The description for the DB cluster parameter group.
Family This property is required. string
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values:

  • aurora-mysql
  • aurora-postgresql
  • mysql
  • postgres
Parameters This property is required. object

Provides a list of parameters for the DB cluster parameter group.

Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

DbClusterParameterGroupName string

The name of the DB cluster parameter group. Constraints:

  • Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

Tags List<Pulumi.AwsNative.Inputs.Tag>
Tags to assign to the DB cluster parameter group.
Description This property is required. string
The description for the DB cluster parameter group.
Family This property is required. string
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values:

  • aurora-mysql
  • aurora-postgresql
  • mysql
  • postgres
Parameters This property is required. interface{}

Provides a list of parameters for the DB cluster parameter group.

Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

DbClusterParameterGroupName string

The name of the DB cluster parameter group. Constraints:

  • Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

Tags TagArgs
Tags to assign to the DB cluster parameter group.
description This property is required. String
The description for the DB cluster parameter group.
family This property is required. String
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values:

  • aurora-mysql
  • aurora-postgresql
  • mysql
  • postgres
parameters This property is required. Object

Provides a list of parameters for the DB cluster parameter group.

Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

dbClusterParameterGroupName String

The name of the DB cluster parameter group. Constraints:

  • Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

tags List<Tag>
Tags to assign to the DB cluster parameter group.
description This property is required. string
The description for the DB cluster parameter group.
family This property is required. string
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values:

  • aurora-mysql
  • aurora-postgresql
  • mysql
  • postgres
parameters This property is required. any

Provides a list of parameters for the DB cluster parameter group.

Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

dbClusterParameterGroupName string

The name of the DB cluster parameter group. Constraints:

  • Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

tags Tag[]
Tags to assign to the DB cluster parameter group.
description This property is required. str
The description for the DB cluster parameter group.
family This property is required. str
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values:

  • aurora-mysql
  • aurora-postgresql
  • mysql
  • postgres
parameters This property is required. Any

Provides a list of parameters for the DB cluster parameter group.

Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

db_cluster_parameter_group_name str

The name of the DB cluster parameter group. Constraints:

  • Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

tags Sequence[TagArgs]
Tags to assign to the DB cluster parameter group.
description This property is required. String
The description for the DB cluster parameter group.
family This property is required. String
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family. Aurora MySQL Example: aurora-mysql5.7, aurora-mysql8.0 Aurora PostgreSQL Example: aurora-postgresql14 RDS for MySQL Example: mysql8.0 RDS for PostgreSQL Example: postgres13 To list all of the available parameter group families for a DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine> For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql The output contains duplicates. The following are the valid DB engine values:

  • aurora-mysql
  • aurora-postgresql
  • mysql
  • postgres
parameters This property is required. Any

Provides a list of parameters for the DB cluster parameter group.

Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

dbClusterParameterGroupName String

The name of the DB cluster parameter group. Constraints:

  • Must not match the name of an existing DB cluster parameter group.

This value is stored as a lowercase string.

tags List<Property Map>
Tags to assign to the DB cluster parameter group.

Outputs

All input properties are implicitly available as output properties. Additionally, the DbClusterParameterGroup resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native