Interface ICfnDBParameterGroupProps

Properties for defining a CfnDBParameterGroup.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.AWS.RDS.dll

Syntax (csharp)

public interface ICfnDBParameterGroupProps

Syntax (vb)

Public Interface ICfnDBParameterGroupProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.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 cfnDBParameterGroupProps = new CfnDBParameterGroupProps {
    Description = "description",
    Family = "family",

    // the properties below are optional
    DbParameterGroupName = "dbParameterGroupName",
    Parameters = parameters,
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

DbParameterGroupName	The name of the DB parameter group.
Description	Provides the customer-specified description for this DB parameter group.
Family	The DB parameter group family name.
Parameters	An array of parameter names and values for the parameter update.
Tags	An optional array of key-value pairs to apply to this DB parameter group.

Properties

DbParameterGroupName

The name of the DB parameter group.

virtual string DbParameterGroupName { get; }

Property Value

System.String

Remarks

Constraints:

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.

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

Description

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

string Description { get; }

Property Value

System.String

Remarks

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

Family

The DB parameter group family name.

string Family { get; }

Property Value

System.String

Remarks

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 .

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

Parameters

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

virtual object Parameters { get; }

Property Value

System.Object

Remarks

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.

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