interface CfnDBClusterParameterGroupProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.RDS.CfnDBClusterParameterGroupProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsrds#CfnDBClusterParameterGroupProps |
![]() | software.amazon.awscdk.services.rds.CfnDBClusterParameterGroupProps |
![]() | aws_cdk.aws_rds.CfnDBClusterParameterGroupProps |
![]() | aws-cdk-lib » aws_rds » CfnDBClusterParameterGroupProps |
Properties for defining a CfnDBClusterParameterGroup
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_rds as rds } from 'aws-cdk-lib';
declare const parameters: any;
const cfnDBClusterParameterGroupProps: rds.CfnDBClusterParameterGroupProps = {
description: 'description',
family: 'family',
parameters: parameters,
// the properties below are optional
dbClusterParameterGroupName: 'dbClusterParameterGroupName',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
description | string | The description for the DB cluster parameter group. |
family | string | The DB cluster parameter group family name. |
parameters | any | Provides a list of parameters for the DB cluster parameter group. |
db | string | The name of the DB cluster parameter group. |
tags? | Cfn [] | Tags to assign to the DB cluster parameter group. |
description
Type:
string
The description for the DB cluster parameter group.
family
Type:
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
Type:
any
Provides a list of parameters for the DB cluster parameter group.
dbClusterParameterGroupName?
Type:
string
(optional)
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?
Type:
Cfn
[]
(optional)
Tags to assign to the DB cluster parameter group.