Class DatabaseClusterBase
(experimental) A new or imported database cluster.
Inherited Members
Namespace: Amazon.CDK.AWS.Neptune
Assembly: Amazon.CDK.AWS.Neptune.dll
Syntax (csharp)
public abstract class DatabaseClusterBase : Resource, IDatabaseCluster, IResource, IConstruct, IDependable, IConnectable
Syntax (vb)
Public MustInherit Class DatabaseClusterBase
Inherits Resource
Implements IDatabaseCluster, IResource, IConstruct, IDependable, 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.EC2;
using Amazon.CDK.AWS.Neptune;
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
DatabaseClusterBase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
DatabaseClusterBase(Construct, String, IResourceProps) |
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 |
Methods
FromDatabaseClusterAttributes(Construct, String, IDatabaseClusterAttributes) | (experimental) Import an existing DatabaseCluster from properties. |
GrantConnect(IGrantable) | (experimental) Grant the given identity connection access to the database. |
Constructors
DatabaseClusterBase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected DatabaseClusterBase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
DatabaseClusterBase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected DatabaseClusterBase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
DatabaseClusterBase(Construct, String, IResourceProps)
protected DatabaseClusterBase(Construct scope, string id, IResourceProps props = null)
Parameters
- scope Constructs.Construct
- id System.String
- props IResourceProps
Properties
ClusterEndpoint
(experimental) The endpoint to use for read/write operations.
public abstract Endpoint ClusterEndpoint { get; }
Property Value
Remarks
Stability: Experimental
ClusterIdentifier
(experimental) Identifier of the cluster.
public abstract string ClusterIdentifier { get; }
Property Value
System.String
Remarks
Stability: Experimental
ClusterReadEndpoint
(experimental) Endpoint to use for load-balanced read-only operations.
public abstract Endpoint ClusterReadEndpoint { get; }
Property Value
Remarks
Stability: Experimental
ClusterResourceIdentifier
(experimental) Resource identifier of the cluster.
public abstract string ClusterResourceIdentifier { get; }
Property Value
System.String
Remarks
Stability: Experimental
Connections
(experimental) The connections object to implement IConnectable.
public abstract Connections_ Connections { get; }
Property Value
Remarks
Stability: Experimental
EnableIamAuthentication
protected abstract Nullable<bool> EnableIamAuthentication { get; set; }
Property Value
System.Nullable<System.Boolean>
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 Constructs.Construct
- id System.String
- attrs IDatabaseClusterAttributes
Returns
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
Remarks
Stability: Experimental