software.amazon.awscdk.services.neptune

Class DatabaseClusterBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.neptune.DatabaseClusterBase

All Implemented Interfaces:

IDependable, IResource, IConnectable, IDatabaseCluster, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

Direct Known Subclasses:

DatabaseCluster

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:35.241Z")
 @Stability(value=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.ec2.*;
 import software.amazon.awscdk.services.neptune.*;
 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.constructs.Construct

software.constructs.Construct.Builder

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.neptune.IDatabaseCluster

IDatabaseCluster.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatabaseClusterBase(software.constructs.Construct scope, String id)
protected	DatabaseClusterBase(software.constructs.Construct scope, String id, ResourceProps props)
protected	DatabaseClusterBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseClusterBase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IDatabaseCluster	fromDatabaseClusterAttributes(software.constructs.Construct scope, String id, DatabaseClusterAttributes attrs) (experimental) Import an existing DatabaseCluster from properties.
abstract Endpoint	getClusterEndpoint() (experimental) The endpoint to use for read/write operations.
abstract String	getClusterIdentifier() (experimental) Identifier of the cluster.
abstract Endpoint	getClusterReadEndpoint() (experimental) Endpoint to use for load-balanced read-only operations.
abstract String	getClusterResourceIdentifier() (experimental) Resource identifier of the cluster.
abstract Connections	getConnections() (experimental) The connections object to implement IConnectable.
protected abstract Boolean	getEnableIamAuthentication()
Grant	grantConnect(IGrantable grantee) (experimental) Grant the given identity connection access to the database.
protected abstract void	setEnableIamAuthentication(Boolean value)

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

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.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

DatabaseClusterBase

protected DatabaseClusterBase(software.amazon.jsii.JsiiObjectRef objRef)

DatabaseClusterBase

protected DatabaseClusterBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DatabaseClusterBase

@Stability(value=Experimental)
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(value=Experimental)
protected DatabaseClusterBase(@NotNull
                                                             software.constructs.Construct scope,
                                                             @NotNull
                                                             String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromDatabaseClusterAttributes

@Stability(value=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.

grantConnect

@Stability(value=Experimental)
 @NotNull
public Grant grantConnect(@NotNull
                                                                   IGrantable grantee)

(experimental) Grant the given identity connection access to the database.

Specified by:

grantConnect in interface IDatabaseCluster

Parameters:

grantee - This parameter is required.

getClusterEndpoint

@Stability(value=Experimental)
 @NotNull
public abstract Endpoint getClusterEndpoint()

(experimental) The endpoint to use for read/write operations.

Specified by:

getClusterEndpoint in interface IDatabaseCluster

getClusterIdentifier

@Stability(value=Experimental)
 @NotNull
public abstract String getClusterIdentifier()

(experimental) Identifier of the cluster.

Specified by:

getClusterIdentifier in interface IDatabaseCluster

getClusterReadEndpoint

@Stability(value=Experimental)
 @NotNull
public abstract Endpoint getClusterReadEndpoint()

(experimental) Endpoint to use for load-balanced read-only operations.

Specified by:

getClusterReadEndpoint in interface IDatabaseCluster

getClusterResourceIdentifier

@Stability(value=Experimental)
 @NotNull
public abstract String getClusterResourceIdentifier()

(experimental) Resource identifier of the cluster.

Specified by:

getClusterResourceIdentifier in interface IDatabaseCluster

getConnections

@Stability(value=Experimental)
 @NotNull
public abstract Connections getConnections()

(experimental) The connections object to implement IConnectable.

Specified by:

getConnections in interface IConnectable

getEnableIamAuthentication

@Stability(value=Experimental)
 @Nullable
protected abstract Boolean getEnableIamAuthentication()

setEnableIamAuthentication

@Stability(value=Experimental)
protected abstract void setEnableIamAuthentication(@Nullable
                                                                                  Boolean value)