Class CfnDBClusterParameterGroup

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnDBClusterParameterGroup
Inherited Members
Namespace: Amazon.CDK.AWS.Neptune
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBClusterParameterGroup : CfnResource, IInspectable, IDBClusterParameterGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnDBClusterParameterGroup Inherits CfnResource Implements IInspectable, IDBClusterParameterGroupRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

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 AWS::Neptune::DBClusterParameterGroup.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

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

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

A reference to a DBClusterParameterGroup resource.
Description

Provides the customer-specified description for this DB cluster parameter group.
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.
Name

Provides the name of the DB cluster parameter group.
Parameters

The parameters to set for this DB cluster parameter group.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The tags that you want to attach to this parameter group.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnDBClusterParameterGroup(object)

Checks whether the given object is a CfnDBClusterParameterGroup.
RenderProperties(IDictionary<string, object>)

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

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 string

Construct identifier for this resource (unique in its scope).

props ICfnDBClusterParameterGroupProps

Resource properties.

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

CfnProperties

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

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

IDictionary<string, object>

Overrides
Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

CfnPropertyNames

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

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

DbClusterParameterGroupRef

A reference to a DBClusterParameterGroup resource.

public virtual IDBClusterParameterGroupReference DbClusterParameterGroupRef { get; }
Property Value

IDBClusterParameterGroupReference

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

Description

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

public virtual string Description { get; set; }
Property Value

string

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

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

string

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

Name

Provides the name of the DB cluster parameter group.

public virtual string? Name { get; set; }
Property Value

string

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

Parameters

The parameters to set for this DB cluster parameter group.

public virtual object Parameters { get; set; }
Property Value

object

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

TagsRaw

The tags that you want to attach to this parameter group.

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

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.

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

IsCfnDBClusterParameterGroup(object)

Checks whether the given object is a CfnDBClusterParameterGroup.

public static bool IsCfnDBClusterParameterGroup(object x)
Parameters
x object
Returns

bool

Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

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

IDictionary<string, object>

Overrides
Remarks
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 <code>DBClusterParameterGroup</code> that you associate with the <code>DBCluster</code> , it is best to specify an <code>EngineVersion</code> property in the <code>DBCluster</code> . That <code>EngineVersion</code> needs to be compatible with the value of the <code>Family</code> property in the <code>DBClusterParameterGroup</code> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

CloudformationResource: AWS::Neptune::DBClusterParameterGroup

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable