Interface ICfnDBClusterParameterGroupProps
Properties for defining a CfnDBClusterParameterGroup
.
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public interface ICfnDBClusterParameterGroupProps
Syntax (vb)
Public Interface ICfnDBClusterParameterGroupProps
Remarks
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
Properties
DbClusterParameterGroupName | The name of the DB cluster parameter group. |
Description | A friendly description for this 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 | An optional array of key-value pairs to apply to this DB cluster parameter group. |
Properties
DbClusterParameterGroupName
The name of the DB cluster parameter group.
virtual string DbClusterParameterGroupName { get; }
Property Value
System.String
Remarks
Constraints:
If you don't specify a value for DBClusterParameterGroupName
property, a name is automatically created for the DB cluster parameter group.
This value is stored as a lowercase string.
Description
A friendly description for this DB cluster parameter group.
string Description { get; }
Property Value
System.String
Remarks
Family
The DB cluster parameter group family name.
string Family { get; }
Property Value
System.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 DB engine and engine version compatible with that DB cluster parameter group family.
The DB cluster parameter group family can't be changed when updating a DB cluster 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 CreateDBClusterParameterGroup
.
Parameters
Provides a list of parameters for the DB cluster parameter group.
object Parameters { get; }
Property Value
System.Object
Remarks
Tags
An optional array of key-value pairs to apply to this DB cluster parameter group.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]