Class CfnDBClusterParameterGroupProps

Properties for defining a CfnDBClusterParameterGroup.

Inheritance

object

CfnDBClusterParameterGroupProps

Implements

ICfnDBClusterParameterGroupProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDBClusterParameterGroupProps : ICfnDBClusterParameterGroupProps

Syntax (vb)

Public Class CfnDBClusterParameterGroupProps Implements ICfnDBClusterParameterGroupProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var parameters;

             var cfnDBClusterParameterGroupProps = new CfnDBClusterParameterGroupProps {
                 Description = "description",
                 Family = "family",
                 Parameters = parameters,

                 // the properties below are optional
                 DbClusterParameterGroupName = "dbClusterParameterGroupName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnDBClusterParameterGroupProps()

Properties for defining a CfnDBClusterParameterGroup.

Properties

DbClusterParameterGroupName	The name of the DB cluster parameter group.
Description	The description for the DB cluster parameter group.
Family	The DB cluster parameter group family name.
Parameters	Provides a list of parameters for the DB cluster parameter group.
Tags	Tags to assign to the DB cluster parameter group.

Constructors

CfnDBClusterParameterGroupProps()

Properties for defining a CfnDBClusterParameterGroup.

public CfnDBClusterParameterGroupProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.RDS;

             var parameters;

             var cfnDBClusterParameterGroupProps = new CfnDBClusterParameterGroupProps {
                 Description = "description",
                 Family = "family",
                 Parameters = parameters,

                 // the properties below are optional
                 DbClusterParameterGroupName = "dbClusterParameterGroupName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

DbClusterParameterGroupName

The name of the DB cluster parameter group.

public string? DbClusterParameterGroupName { get; set; }

Property Value

string

Remarks

Constraints:

This value is stored as a lowercase string.

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

Description

The description for the DB cluster parameter group.

public string Description { get; set; }

Property Value

string

Remarks

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

Family

The DB cluster parameter group family name.

public string Family { get; set; }

Property Value

string

Remarks

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:

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

Parameters

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

public object Parameters { get; set; }