Class CfnDBClusterParameterGroupProps

Properties for defining a CfnDBClusterParameterGroup.

Inheritance

System.Object

CfnDBClusterParameterGroupProps

Implements

ICfnDBClusterParameterGroupProps

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.AWS.RDS.dll

Syntax (csharp)

public class CfnDBClusterParameterGroupProps : Object, ICfnDBClusterParameterGroupProps

Syntax (vb)

Public Class CfnDBClusterParameterGroupProps
    Inherits Object
    Implements ICfnDBClusterParameterGroupProps

Remarks

Link: 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

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.

Constructors

CfnDBClusterParameterGroupProps()

public CfnDBClusterParameterGroupProps()

Properties

DbClusterParameterGroupName

The name of the DB cluster parameter group.

public string DbClusterParameterGroupName { get; set; }

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.

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

Description

A friendly description for this DB cluster parameter group.

public string Description { get; set; }

Property Value

System.String

Remarks

Link: 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

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 .

Link: 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; }

Property Value

System.Object

Remarks

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

Implements

ICfnDBClusterParameterGroupProps