2.241.0

interface CfnDBClusterParameterGroupMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.RDS.Mixins.CfnDBClusterParameterGroupMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsrds/mixins#CfnDBClusterParameterGroupMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.rds.mixins.CfnDBClusterParameterGroupMixinProps
Pythonaws_cdk.mixins_preview.aws_rds.mixins.CfnDBClusterParameterGroupMixinProps
TypeScript @aws-cdk/mixins-preview » aws_rds » mixins » CfnDBClusterParameterGroupMixinProps

Properties for CfnDBClusterParameterGroupPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as rds_mixins } from '@aws-cdk/mixins-preview/aws-rds';

declare const parameters: any;
const cfnDBClusterParameterGroupMixinProps: rds_mixins.CfnDBClusterParameterGroupMixinProps = {
  dbClusterParameterGroupName: 'dbClusterParameterGroupName',
  description: 'description',
  family: 'family',
  parameters: parameters,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
dbClusterParameterGroupName?stringThe name of the DB cluster parameter group.
description?stringThe description for the DB cluster parameter group.
family?stringThe DB cluster parameter group family name.
parameters?anyProvides a list of parameters for the DB cluster parameter group.
tags?CfnTag[]Tags to assign to 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-dbclusterparametergroupname

description?

Type: string (optional)

The description for the DB cluster parameter group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-description

family?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family

parameters?

Type: any (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-parameters

tags?

Type: CfnTag[] (optional)

Tags to assign to the DB cluster parameter group.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-tags

← PreviousNext →