Class DatabaseCluster
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.neptune.alpha.DatabaseClusterBase
software.amazon.awscdk.services.neptune.alpha.DatabaseCluster
- All Implemented Interfaces:
IResource
,IConnectable
,IDatabaseCluster
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-29T22:54:27.962Z")
@Stability(Experimental)
public class DatabaseCluster
extends DatabaseClusterBase
implements IDatabaseCluster
(experimental) Create a clustered database with a given number of instances.
Example:
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "ServerlessDatabase") .vpc(vpc) .instanceType(InstanceType.SERVERLESS) .serverlessScalingConfiguration(ServerlessScalingConfiguration.builder() .minCapacity(1) .maxCapacity(5) .build()) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
(experimental) A fluent builder forDatabaseCluster
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.neptune.alpha.IDatabaseCluster
IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Number
(experimental) The default number of instances in the Neptune cluster if none are specified. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DatabaseCluster
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
DatabaseCluster
(software.amazon.jsii.JsiiObjectRef objRef) DatabaseCluster
(software.constructs.Construct scope, String id, DatabaseClusterProps props) -
Method Summary
Modifier and TypeMethodDescription(experimental) The endpoint to use for read/write operations.(experimental) Identifier of the cluster.(experimental) Endpoint to use for load-balanced read-only operations.(experimental) The resource id for the cluster;(experimental) The connections object to implement IConnectable.protected Boolean
(experimental) Endpoints which address each individual instance.(experimental) Identifiers of the instance.(experimental) Subnet group used by the DB.getVpc()
(experimental) The VPC where the DB subnet group is created.(experimental) The subnets used by the DB subnet group.protected void
Methods inherited from class software.amazon.awscdk.services.neptune.alpha.DatabaseClusterBase
fromDatabaseClusterAttributes, grant, grantConnect, metric, metric
Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.services.neptune.alpha.IDatabaseCluster
grant, grantConnect, metric, metric
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
DEFAULT_NUM_INSTANCES
(experimental) The default number of instances in the Neptune cluster if none are specified.
-
-
Constructor Details
-
DatabaseCluster
protected DatabaseCluster(software.amazon.jsii.JsiiObjectRef objRef) -
DatabaseCluster
protected DatabaseCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
DatabaseCluster
@Stability(Experimental) public DatabaseCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DatabaseClusterProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
getClusterEndpoint
(experimental) The endpoint to use for read/write operations.- Specified by:
getClusterEndpoint
in interfaceIDatabaseCluster
- Specified by:
getClusterEndpoint
in classDatabaseClusterBase
-
getClusterIdentifier
(experimental) Identifier of the cluster.- Specified by:
getClusterIdentifier
in interfaceIDatabaseCluster
- Specified by:
getClusterIdentifier
in classDatabaseClusterBase
-
getClusterReadEndpoint
(experimental) Endpoint to use for load-balanced read-only operations.- Specified by:
getClusterReadEndpoint
in interfaceIDatabaseCluster
- Specified by:
getClusterReadEndpoint
in classDatabaseClusterBase
-
getClusterResourceIdentifier
(experimental) The resource id for the cluster;for example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
- Specified by:
getClusterResourceIdentifier
in interfaceIDatabaseCluster
- Specified by:
getClusterResourceIdentifier
in classDatabaseClusterBase
-
getConnections
(experimental) The connections object to implement IConnectable.- Specified by:
getConnections
in interfaceIConnectable
- Specified by:
getConnections
in classDatabaseClusterBase
-
getInstanceEndpoints
(experimental) Endpoints which address each individual instance. -
getInstanceIdentifiers
(experimental) Identifiers of the instance. -
getSubnetGroup
(experimental) Subnet group used by the DB. -
getVpc
(experimental) The VPC where the DB subnet group is created. -
getVpcSubnets
(experimental) The subnets used by the DB subnet group. -
getEnableIamAuthentication
- Specified by:
getEnableIamAuthentication
in classDatabaseClusterBase
-
setEnableIamAuthentication
- Specified by:
setEnableIamAuthentication
in classDatabaseClusterBase
-