1.204.0

interface CfnDBParameterGroupProps

LanguageType name
.NETAmazon.CDK.AWS.RDS.CfnDBParameterGroupProps
Javasoftware.amazon.awscdk.services.rds.CfnDBParameterGroupProps
Pythonaws_cdk.aws_rds.CfnDBParameterGroupProps
TypeScript @aws-cdk/aws-rds » CfnDBParameterGroupProps

Properties for defining a CfnDBParameterGroup.

Example

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

declare const parameters: any;
const cfnDBParameterGroupProps: rds.CfnDBParameterGroupProps = {
  description: 'description',
  family: 'family',

  // the properties below are optional
  dbParameterGroupName: 'dbParameterGroupName',
  parameters: parameters,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
descriptionstringProvides the customer-specified description for this DB parameter group.
familystringThe DB parameter group family name.
dbParameterGroupName?stringThe name of the DB parameter group.
parameters?anyAn array of parameter names and values for the parameter update.
tags?CfnTag[]An optional array of key-value pairs to apply to this DB parameter group.

description

Type: string

Provides the customer-specified description for this DB parameter group.

family

Type: string

The DB parameter group family name.

A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.

The DB parameter group family can't be changed when updating a DB parameter group.

To list all of the available parameter group families, use the following command:

aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"

The output contains duplicates.

For more information, see [CreateDBParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html) .

dbParameterGroupName?

Type: string (optional)

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens

If you don't specify a value for DBParameterGroupName property, a name is automatically created for the DB parameter group.

This value is stored as a lowercase string.

parameters?

Type: any (optional)

An array of parameter names and values for the parameter update.

At least one parameter name and value must be supplied. Subsequent arguments are optional.

For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see Working with DB Parameter Groups in the Amazon RDS User Guide .

For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see Working with DB Parameter Groups and DB Cluster Parameter Groups in the Amazon Aurora User Guide .

AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.

tags?

Type: CfnTag[] (optional)

An optional array of key-value pairs to apply to this DB parameter group.

Currently, this is the only property that supports drift detection.

← PreviousNext →