Class CfnDBClusterParameterGroup
A CloudFormation AWS::Neptune::DBClusterParameterGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.Neptune
Assembly: Amazon.CDK.AWS.Neptune.dll
Syntax (csharp)
public class CfnDBClusterParameterGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDBClusterParameterGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Neptune::DBClusterParameterGroup
resource creates a new Amazon Neptune DB cluster parameter group.
Applying a parameter group to a DB cluster might require instances to reboot, resulting in a database outage while the instances reboot. > If you provide a custom DBClusterParameterGroup
that you associate with the DBCluster
, it is best to specify an EngineVersion
property in the DBCluster
. That EngineVersion
needs to be compatible with the value of the Family
property in the DBClusterParameterGroup
.
CloudformationResource: AWS::Neptune::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.Neptune;
var parameters;
var cfnDBClusterParameterGroup = new CfnDBClusterParameterGroup(this, "MyCfnDBClusterParameterGroup", new CfnDBClusterParameterGroupProps {
Description = "description",
Family = "family",
Parameters = parameters,
// the properties below are optional
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDBClusterParameterGroup(Construct, String, ICfnDBClusterParameterGroupProps) | Create a new |
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 | |
Description | Provides the customer-specified description for this DB cluster parameter group. |
Family | Must be |
Name | Provides the name of the DB cluster parameter group. |
Parameters | The parameters to set for this DB cluster parameter group. |
Tags | The tags that you want to attach to this 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::Neptune::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
Description
Provides the customer-specified description for this DB cluster parameter group.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Family
Must be neptune1
for engine versions prior to 1.2.0.0 , or neptune1.2
for engine version 1.2.0.0
and higher.
public virtual string Family { get; set; }
Property Value
System.String
Remarks
Name
Provides the name of the DB cluster parameter group.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Parameters
The parameters to set for this DB cluster parameter group.
public virtual object Parameters { get; set; }
Property Value
System.Object
Remarks
The parameters are expressed as a JSON object consisting of key-value pairs.
If you update the parameters, some interruption may occur depending on which parameters you update.
Tags
The tags that you want to attach to this parameter group.
public virtual TagManager Tags { get; }
Property Value
Remarks
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>