Class DatabaseCluster
(experimental) Create a clustered database with a given number of instances.
Inherited Members
Namespace: Amazon.CDK.AWS.Neptune
Assembly: Amazon.CDK.AWS.Neptune.dll
Syntax (csharp)
public class DatabaseCluster : DatabaseClusterBase, IDatabaseCluster, IResource, IConstruct, IDependable, IConnectable
Syntax (vb)
Public Class DatabaseCluster
Inherits DatabaseClusterBase
Implements IDatabaseCluster, IResource, IConstruct, IDependable, IConnectable
Remarks
Stability: Experimental
Resource: AWS::Neptune::DBCluster
ExampleMetadata: infused
Examples
var cluster = new DatabaseCluster(this, "Database", new DatabaseClusterProps {
Vpc = vpc,
InstanceType = InstanceType.R5_LARGE,
Instances = 2
});
Synopsis
Constructors
DatabaseCluster(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
DatabaseCluster(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
DatabaseCluster(Construct, String, IDatabaseClusterProps) |
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) The resource id for the cluster; |
Connections | (experimental) The connections object to implement IConnectable. |
DEFAULT_NUM_INSTANCES | (experimental) The default number of instances in the Neptune cluster if none are specified. |
EnableIamAuthentication | |
InstanceEndpoints | (experimental) Endpoints which address each individual instance. |
InstanceIdentifiers | (experimental) Identifiers of the instance. |
SubnetGroup | (experimental) Subnet group used by the DB. |
Vpc | (experimental) The VPC where the DB subnet group is created. |
VpcSubnets | (experimental) The subnets used by the DB subnet group. |
Constructors
DatabaseCluster(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected DatabaseCluster(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
DatabaseCluster(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected DatabaseCluster(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
DatabaseCluster(Construct, String, IDatabaseClusterProps)
public DatabaseCluster(Construct scope, string id, IDatabaseClusterProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IDatabaseClusterProps
Remarks
Stability: Experimental
Properties
ClusterEndpoint
(experimental) The endpoint to use for read/write operations.
public override Endpoint ClusterEndpoint { get; }
Property Value
Overrides
Remarks
Stability: Experimental
ClusterIdentifier
(experimental) Identifier of the cluster.
public override string ClusterIdentifier { get; }
Property Value
System.String
Overrides
Remarks
Stability: Experimental
ClusterReadEndpoint
(experimental) Endpoint to use for load-balanced read-only operations.
public override Endpoint ClusterReadEndpoint { get; }
Property Value
Overrides
Remarks
Stability: Experimental
ClusterResourceIdentifier
(experimental) The resource id for the cluster;
public override string ClusterResourceIdentifier { get; }
Property Value
System.String
Overrides
Remarks
for example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
Stability: Experimental
Attribute: ClusterResourceId
Connections
(experimental) The connections object to implement IConnectable.
public override Connections_ Connections { get; }
Property Value
Overrides
Remarks
Stability: Experimental
DEFAULT_NUM_INSTANCES
(experimental) The default number of instances in the Neptune cluster if none are specified.
public static double DEFAULT_NUM_INSTANCES { get; }
Property Value
System.Double
Remarks
Stability: Experimental
EnableIamAuthentication
protected override Nullable<bool> EnableIamAuthentication { get; set; }
Property Value
System.Nullable<System.Boolean>
Overrides
Remarks
Stability: Experimental
InstanceEndpoints
(experimental) Endpoints which address each individual instance.
public virtual Endpoint[] InstanceEndpoints { get; }
Property Value
Endpoint[]
Remarks
Stability: Experimental
InstanceIdentifiers
(experimental) Identifiers of the instance.
public virtual string[] InstanceIdentifiers { get; }
Property Value
System.String[]
Remarks
Stability: Experimental
SubnetGroup
(experimental) Subnet group used by the DB.
public virtual ISubnetGroup SubnetGroup { get; }
Property Value
Remarks
Stability: Experimental
Vpc
(experimental) The VPC where the DB subnet group is created.
public virtual IVpc Vpc { get; }
Property Value
Remarks
Stability: Experimental
VpcSubnets
(experimental) The subnets used by the DB subnet group.
public virtual ISubnetSelection VpcSubnets { get; }
Property Value
Remarks
Stability: Experimental