Interface ICfnDBParameterGroupProps

Properties for defining a CfnDBParameterGroup.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnDBParameterGroupProps

Syntax (vb)

Public Interface ICfnDBParameterGroupProps

Remarks

See: 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	A mapping of parameter names and values for the parameter update.
Tags	Tags to assign to the DB parameter group.

Properties

DbParameterGroupName

The name of the DB parameter group.

string? DbParameterGroupName { get; }

Property Value

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.

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

string

Remarks

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

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 database engine and engine version compatible with that DB parameter group family.

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 MySQL DB engine, use the following command:

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

The output contains duplicates.

The following are the valid DB engine values:

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

Parameters

A mapping of parameter names and values for the parameter update.

object? Parameters { get; }

Property Value

object

Remarks

You must specify at least one parameter name and value.

For more information about parameter groups, see Working with parameter groups in the Amazon RDS User Guide , or Working with 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.

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