software.amazon.awscdk.services.neptune

Class DatabaseInstance

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.neptune.DatabaseInstance

All Implemented Interfaces:

IConstruct, IDependable, IResource, IDatabaseInstance

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.822Z")
public class DatabaseInstance
extends Resource
implements IDatabaseInstance

(experimental) A database instance.

Example:

 DatabaseInstance replica1 = DatabaseInstance.Builder.create(this, "Instance")
         .cluster(cluster)
         .instanceType(InstanceType.R5_LARGE)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatabaseInstance.Builder (experimental) A fluent builder for DatabaseInstance.

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

IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatabaseInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DatabaseInstance(software.amazon.jsii.JsiiObjectRef objRef)
	DatabaseInstance(software.constructs.Construct scope, java.lang.String id, DatabaseInstanceProps props)

Method Summary

Modifier and Type	Method and Description
static IDatabaseInstance	fromDatabaseInstanceAttributes(software.constructs.Construct scope, java.lang.String id, DatabaseInstanceAttributes attrs) (experimental) Import an existing database instance.
IDatabaseCluster	getCluster() (experimental) The instance's database cluster.
java.lang.String	getDbInstanceEndpointAddress() (experimental) The instance endpoint address.
java.lang.String	getDbInstanceEndpointPort() (experimental) The instance endpoint port.
Endpoint	getInstanceEndpoint() (experimental) The instance endpoint.
java.lang.String	getInstanceIdentifier() (experimental) The instance identifier.

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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Detail

DatabaseInstance

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

DatabaseInstance

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

DatabaseInstance

public DatabaseInstance(software.constructs.Construct scope,
                        java.lang.String id,
                        DatabaseInstanceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromDatabaseInstanceAttributes

public static IDatabaseInstance fromDatabaseInstanceAttributes(software.constructs.Construct scope,
                                                               java.lang.String id,
                                                               DatabaseInstanceAttributes attrs)

(experimental) Import an existing database instance.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

getCluster

public IDatabaseCluster getCluster()

(experimental) The instance's database cluster.

getDbInstanceEndpointAddress

public java.lang.String getDbInstanceEndpointAddress()

(experimental) The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

getDbInstanceEndpointPort

public java.lang.String getDbInstanceEndpointPort()

(experimental) The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

getInstanceEndpoint

public Endpoint getInstanceEndpoint()

(experimental) The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

getInstanceIdentifier

public java.lang.String getInstanceIdentifier()

(experimental) The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance