Class CfnDBClusterParameterGroup

A CloudFormation AWS::RDS::DBClusterParameterGroup.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnDBClusterParameterGroup

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.AWS.RDS.dll

Syntax (csharp)

public class CfnDBClusterParameterGroup : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnDBClusterParameterGroup
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group.

For information about configuring parameters for Amazon Aurora DB clusters, see Working with parameter groups in the Amazon Aurora User Guide .

If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.

If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.

CloudformationResource: AWS::RDS::DBClusterParameterGroup

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 cfnDBClusterParameterGroup = new CfnDBClusterParameterGroup(this, "MyCfnDBClusterParameterGroup", 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

CfnDBClusterParameterGroup(Construct, String, ICfnDBClusterParameterGroupProps)	Create a new `AWS::RDS::DBClusterParameterGroup`.
CfnDBClusterParameterGroup(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnDBClusterParameterGroup(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnDBClusterParameterGroup(Construct, String, ICfnDBClusterParameterGroupProps)

Create a new AWS::RDS::DBClusterParameterGroup.

public CfnDBClusterParameterGroup(Construct scope, string id, ICfnDBClusterParameterGroupProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnDBClusterParameterGroupProps

resource properties.

CfnDBClusterParameterGroup(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnDBClusterParameterGroup(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnDBClusterParameterGroup(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnDBClusterParameterGroup(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

DbClusterParameterGroupName

The name of the DB cluster parameter group.

public virtual 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 virtual 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 virtual 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 virtual 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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable