@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:43.815Z") public class DatabaseCluster extends DatabaseClusterBase implements IDatabaseCluster
Example:
DatabaseCluster cluster = DatabaseCluster.Builder.create(this, "Database") .vpc(vpc) .instanceType(InstanceType.R5_LARGE) .instances(2) .build();
Modifier and Type | Class and Description |
---|---|
static class |
DatabaseCluster.Builder
(experimental) A fluent builder for
DatabaseCluster . |
IDatabaseCluster.Jsii$Default, IDatabaseCluster.Jsii$Proxy
Modifier and Type | Field and Description |
---|---|
static java.lang.Number |
DEFAULT_NUM_INSTANCES
(experimental) The default number of instances in the Neptune cluster if none are specified.
|
Modifier | Constructor and Description |
---|---|
protected |
DatabaseCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
DatabaseCluster(software.amazon.jsii.JsiiObjectRef objRef) |
|
DatabaseCluster(software.constructs.Construct scope,
java.lang.String id,
DatabaseClusterProps props) |
Modifier and Type | Method and Description |
---|---|
Endpoint |
getClusterEndpoint()
(experimental) The endpoint to use for read/write operations.
|
java.lang.String |
getClusterIdentifier()
(experimental) Identifier of the cluster.
|
Endpoint |
getClusterReadEndpoint()
(experimental) Endpoint to use for load-balanced read-only operations.
|
java.lang.String |
getClusterResourceIdentifier()
(experimental) The resource id for the cluster;
|
Connections |
getConnections()
(experimental) The connections object to implement IConnectable.
|
protected java.lang.Boolean |
getEnableIamAuthentication() |
java.util.List<Endpoint> |
getInstanceEndpoints()
(experimental) Endpoints which address each individual instance.
|
java.util.List<java.lang.String> |
getInstanceIdentifiers()
(experimental) Identifiers of the instance.
|
ISubnetGroup |
getSubnetGroup()
(experimental) Subnet group used by the DB.
|
IVpc |
getVpc()
(experimental) The VPC where the DB subnet group is created.
|
SubnetSelection |
getVpcSubnets()
(experimental) The subnets used by the DB subnet group.
|
protected void |
setEnableIamAuthentication(java.lang.Boolean value) |
fromDatabaseClusterAttributes, grantConnect
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
grantConnect
applyRemovalPolicy, getEnv, getStack
getNode
public static final java.lang.Number DEFAULT_NUM_INSTANCES
protected DatabaseCluster(software.amazon.jsii.JsiiObjectRef objRef)
protected DatabaseCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public DatabaseCluster(software.constructs.Construct scope, java.lang.String id, DatabaseClusterProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public Endpoint getClusterEndpoint()
getClusterEndpoint
in interface IDatabaseCluster
getClusterEndpoint
in class DatabaseClusterBase
public java.lang.String getClusterIdentifier()
getClusterIdentifier
in interface IDatabaseCluster
getClusterIdentifier
in class DatabaseClusterBase
public Endpoint getClusterReadEndpoint()
getClusterReadEndpoint
in interface IDatabaseCluster
getClusterReadEndpoint
in class DatabaseClusterBase
public java.lang.String getClusterResourceIdentifier()
for example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
getClusterResourceIdentifier
in interface IDatabaseCluster
getClusterResourceIdentifier
in class DatabaseClusterBase
public Connections getConnections()
getConnections
in interface IConnectable
getConnections
in class DatabaseClusterBase
public java.util.List<Endpoint> getInstanceEndpoints()
public java.util.List<java.lang.String> getInstanceIdentifiers()
public ISubnetGroup getSubnetGroup()
public IVpc getVpc()
public SubnetSelection getVpcSubnets()
protected java.lang.Boolean getEnableIamAuthentication()
getEnableIamAuthentication
in class DatabaseClusterBase
protected void setEnableIamAuthentication(java.lang.Boolean value)
setEnableIamAuthentication
in class DatabaseClusterBase