Class DatabaseClusterBase
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.neptune.alpha.DatabaseClusterBase
- All Implemented Interfaces:
IResource
,IConnectable
,IDatabaseCluster
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
- Direct Known Subclasses:
DatabaseCluster
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-29T22:54:27.964Z")
@Stability(Experimental)
public abstract class DatabaseClusterBase
extends Resource
implements IDatabaseCluster
(experimental) A new or imported database cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.neptune.alpha.*; import software.amazon.awscdk.services.ec2.*; SecurityGroup securityGroup; IDatabaseCluster databaseClusterBase = DatabaseClusterBase.fromDatabaseClusterAttributes(this, "MyDatabaseClusterBase", DatabaseClusterAttributes.builder() .clusterEndpointAddress("clusterEndpointAddress") .clusterIdentifier("clusterIdentifier") .clusterResourceIdentifier("clusterResourceIdentifier") .port(123) .readerEndpointAddress("readerEndpointAddress") .securityGroup(securityGroup) .build());
-
Nested Class Summary
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
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DatabaseClusterBase
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
DatabaseClusterBase
(software.amazon.jsii.JsiiObjectRef objRef) protected
DatabaseClusterBase
(software.constructs.Construct scope, String id) protected
DatabaseClusterBase
(software.constructs.Construct scope, String id, ResourceProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic IDatabaseCluster
fromDatabaseClusterAttributes
(software.constructs.Construct scope, String id, DatabaseClusterAttributes attrs) (experimental) Import an existing DatabaseCluster from properties.abstract Endpoint
(experimental) The endpoint to use for read/write operations.abstract String
(experimental) Identifier of the cluster.abstract Endpoint
(experimental) Endpoint to use for load-balanced read-only operations.abstract String
(experimental) Resource identifier of the cluster.abstract Connections
(experimental) The connections object to implement IConnectable.protected abstract Boolean
grant
(IGrantable grantee, @NotNull String... actions) (experimental) Grant the given identity the specified actions.grantConnect
(IGrantable grantee) (experimental) Grant the given identity connection access to the database.(experimental) Return the given named metric associated with this DatabaseCluster instance.metric
(String metricName, MetricOptions props) (experimental) Return the given named metric associated with this DatabaseCluster instance.protected abstract void
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.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
DatabaseClusterBase
protected DatabaseClusterBase(software.amazon.jsii.JsiiObjectRef objRef) -
DatabaseClusterBase
protected DatabaseClusterBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
DatabaseClusterBase
@Stability(Stable) protected DatabaseClusterBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
-
-
DatabaseClusterBase
@Stability(Stable) protected DatabaseClusterBase(@NotNull software.constructs.Construct scope, @NotNull String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.
-
-
Method Details
-
fromDatabaseClusterAttributes
@Stability(Experimental) @NotNull public static IDatabaseCluster fromDatabaseClusterAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DatabaseClusterAttributes attrs) (experimental) Import an existing DatabaseCluster from properties.- Parameters:
scope
- This parameter is required.id
- This parameter is required.attrs
- This parameter is required.
-
grant
@Stability(Experimental) @NotNull public Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) (experimental) Grant the given identity the specified actions.- Specified by:
grant
in interfaceIDatabaseCluster
- Parameters:
grantee
- This parameter is required.actions
- This parameter is required.- See Also:
-
grantConnect
(experimental) Grant the given identity connection access to the database.- Specified by:
grantConnect
in interfaceIDatabaseCluster
- Parameters:
grantee
- This parameter is required.
-
metric
@Stability(Experimental) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props) (experimental) Return the given named metric associated with this DatabaseCluster instance.- Specified by:
metric
in interfaceIDatabaseCluster
- Parameters:
metricName
- This parameter is required.props
-- See Also:
-
metric
(experimental) Return the given named metric associated with this DatabaseCluster instance.- Specified by:
metric
in interfaceIDatabaseCluster
- Parameters:
metricName
- This parameter is required.- See Also:
-
getClusterEndpoint
(experimental) The endpoint to use for read/write operations.- Specified by:
getClusterEndpoint
in interfaceIDatabaseCluster
-
getClusterIdentifier
(experimental) Identifier of the cluster.- Specified by:
getClusterIdentifier
in interfaceIDatabaseCluster
-
getClusterReadEndpoint
(experimental) Endpoint to use for load-balanced read-only operations.- Specified by:
getClusterReadEndpoint
in interfaceIDatabaseCluster
-
getClusterResourceIdentifier
(experimental) Resource identifier of the cluster.- Specified by:
getClusterResourceIdentifier
in interfaceIDatabaseCluster
-
getConnections
(experimental) The connections object to implement IConnectable.- Specified by:
getConnections
in interfaceIConnectable
-
getEnableIamAuthentication
-
setEnableIamAuthentication
@Stability(Experimental) protected abstract void setEnableIamAuthentication(@Nullable Boolean value)
-