Class DatabaseClusterBase

(experimental) A new or imported database cluster.

Inheritance
object
Resource
DatabaseClusterBase
DatabaseCluster
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Neptune.Alpha
Assembly: Amazon.CDK.AWS.Neptune.Alpha.dll
Syntax (csharp)
public abstract class DatabaseClusterBase : Resource, IDatabaseCluster, IResource, IConstruct, IDependable, IEnvironmentAware, IConnectable
Syntax (vb)
Public MustInherit Class DatabaseClusterBase Inherits Resource Implements IDatabaseCluster, IResource, IConstruct, IDependable, IEnvironmentAware, IConnectable
Remarks

Stability: Experimental

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.Alpha;
             using Amazon.CDK.AWS.EC2;

             SecurityGroup securityGroup;

             var databaseClusterBase = DatabaseClusterBase.FromDatabaseClusterAttributes(this, "MyDatabaseClusterBase", new DatabaseClusterAttributes {
                 ClusterEndpointAddress = "clusterEndpointAddress",
                 ClusterIdentifier = "clusterIdentifier",
                 ClusterResourceIdentifier = "clusterResourceIdentifier",
                 Port = 123,
                 ReaderEndpointAddress = "readerEndpointAddress",
                 SecurityGroup = securityGroup
             });

Synopsis

Constructors

DatabaseClusterBase(Construct, string, IResourceProps?)

(experimental) A new or imported database cluster.

Properties

ClusterEndpoint

(experimental) The endpoint to use for read/write operations.
ClusterIdentifier

(experimental) Identifier of the cluster.
ClusterReadEndpoint

(experimental) Endpoint to use for load-balanced read-only operations.
ClusterResourceIdentifier

(experimental) Resource identifier of the cluster.
Connections

(experimental) The connections object to implement IConnectable.
EnableIamAuthentication

(experimental) A new or imported database cluster.

Methods

FromDatabaseClusterAttributes(Construct, string, IDatabaseClusterAttributes)

(experimental) Import an existing DatabaseCluster from properties.
Grant(IGrantable, params string[])

(experimental) Grant the given identity the specified actions.
GrantConnect(IGrantable)

(experimental) Grant the given identity connection access to the database.
Metric(string, IMetricOptions?)

(experimental) Return the given named metric associated with this DatabaseCluster instance.

Constructors

DatabaseClusterBase(Construct, string, IResourceProps?)

(experimental) A new or imported database cluster.

protected DatabaseClusterBase(Construct scope, string id, IResourceProps? props = null)
Parameters
scope Construct
id string
props IResourceProps
Remarks

Stability: Experimental

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.Alpha;
             using Amazon.CDK.AWS.EC2;

             SecurityGroup securityGroup;

             var databaseClusterBase = DatabaseClusterBase.FromDatabaseClusterAttributes(this, "MyDatabaseClusterBase", new DatabaseClusterAttributes {
                 ClusterEndpointAddress = "clusterEndpointAddress",
                 ClusterIdentifier = "clusterIdentifier",
                 ClusterResourceIdentifier = "clusterResourceIdentifier",
                 Port = 123,
                 ReaderEndpointAddress = "readerEndpointAddress",
                 SecurityGroup = securityGroup
             });

Properties

ClusterEndpoint

(experimental) The endpoint to use for read/write operations.

public abstract Endpoint ClusterEndpoint { get; }
Property Value

Endpoint

Remarks

Stability: Experimental

ClusterIdentifier

(experimental) Identifier of the cluster.

public abstract string ClusterIdentifier { get; }
Property Value

string

Remarks

Stability: Experimental

ClusterReadEndpoint

(experimental) Endpoint to use for load-balanced read-only operations.

public abstract Endpoint ClusterReadEndpoint { get; }
Property Value

Endpoint

Remarks

Stability: Experimental

ClusterResourceIdentifier

(experimental) Resource identifier of the cluster.

public abstract string ClusterResourceIdentifier { get; }
Property Value

string

Remarks

Stability: Experimental

Connections

(experimental) The connections object to implement IConnectable.

public abstract Connections_ Connections { get; }
Property Value

Connections_

Remarks

Stability: Experimental

EnableIamAuthentication

(experimental) A new or imported database cluster.

protected abstract bool? EnableIamAuthentication { get; set; }
Property Value

bool?

Remarks

Stability: Experimental

Methods

FromDatabaseClusterAttributes(Construct, string, IDatabaseClusterAttributes)

(experimental) Import an existing DatabaseCluster from properties.

public static IDatabaseCluster FromDatabaseClusterAttributes(Construct scope, string id, IDatabaseClusterAttributes attrs)
Parameters
scope Construct
id string
attrs IDatabaseClusterAttributes
Returns

IDatabaseCluster

Remarks

Stability: Experimental

Grant(IGrantable, params string[])

(experimental) Grant the given identity the specified actions.

public virtual Grant Grant(IGrantable grantee, params string[] actions)
Parameters
grantee IGrantable
actions string[]
Returns

Grant

Remarks

Stability: Experimental

GrantConnect(IGrantable)

(experimental) Grant the given identity connection access to the database.

public virtual Grant GrantConnect(IGrantable grantee)
Parameters
grantee IGrantable
Returns

Grant

Remarks

Stability: Experimental

Metric(string, IMetricOptions?)

(experimental) Return the given named metric associated with this DatabaseCluster instance.

public virtual Metric Metric(string metricName, IMetricOptions? props = null)
Parameters
metricName string
props IMetricOptions
Returns

Metric

Remarks

Stability: Experimental

Implements

Constructs.IConstruct
Constructs.IDependable