Class CfnDBClusterParameterGroup
The AWS::RDS::DBClusterParameterGroup
resource creates a new Amazon RDS DB cluster parameter group.
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBClusterParameterGroup : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDBClusterParameterGroup
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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
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(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 |
CfnDBClusterParameterGroup(Construct, String, ICfnDBClusterParameterGroupProps) |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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(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
CfnDBClusterParameterGroup(Construct, String, ICfnDBClusterParameterGroupProps)
public CfnDBClusterParameterGroup(Construct scope, string id, ICfnDBClusterParameterGroupProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDBClusterParameterGroupProps
Resource properties.
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
DbClusterParameterGroupName
The name of the DB cluster parameter group.
public virtual string DbClusterParameterGroupName { get; set; }
Property Value
System.String
Description
A friendly description for this DB cluster parameter group.
public virtual string Description { get; set; }
Property Value
System.String
Family
The DB cluster parameter group family name.
public virtual string Family { get; set; }
Property Value
System.String
Parameters
Provides a list of parameters for the DB cluster parameter group.
public virtual object Parameters { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An optional array of key-value pairs to apply to this DB cluster parameter group.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
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>