Package software.amazon.awscdk.services.rds

Class DatabaseInstanceReadReplica

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.rds.DatabaseInstanceBase

software.amazon.awscdk.services.rds.DatabaseInstanceReadReplica

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, IDatabaseInstance, ISecretAttachmentTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.154Z")
@Stability(Stable)
public class DatabaseInstanceReadReplica
extends DatabaseInstanceBase
implements IDatabaseInstance

A read replica database instance.

Example:

 Vpc vpc;
 DatabaseInstance sourceInstance;
 DatabaseInstanceFromSnapshot.Builder.create(this, "Instance")
         .snapshotIdentifier("my-snapshot")
         .engine(DatabaseInstanceEngine.postgres(PostgresInstanceEngineProps.builder().version(PostgresEngineVersion.VER_12_3).build()))
         // optional, defaults to m5.large
         .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.LARGE))
         .vpc(vpc)
         .build();
 DatabaseInstanceReadReplica.Builder.create(this, "ReadReplica")
         .sourceDatabaseInstance(sourceInstance)
         .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.LARGE))
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DatabaseInstanceReadReplica.Builder	A fluent builder for DatabaseInstanceReadReplica.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IDatabaseInstance.Jsii$Default, IDatabaseInstance.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Connections	getConnections()	Access to network connections.
String	getDbInstanceEndpointAddress()	The instance endpoint address.
String	getDbInstanceEndpointPort()	The instance endpoint port.
protected Boolean	getEnableIamAuthentication()
IInstanceEngine	getEngine()	The engine of this database Instance.
Endpoint	getInstanceEndpoint()	The instance endpoint.
String	getInstanceIdentifier()	The instance identifier.
protected InstanceType	getInstanceType()
protected CfnDBInstanceProps	getNewCfnProps()
IVpc	getVpc()	The VPC where this database instance is deployed.
protected SubnetSelection	getVpcPlacement()
protected void	setEnableIamAuthentication(Boolean value)
protected void	setLogRetention()

Methods inherited from class software.amazon.awscdk.services.rds.DatabaseInstanceBase

addProxy, asSecretAttachmentTarget, fromDatabaseInstanceAttributes, getInstanceArn, grantConnect, metric, metric, metricCPUUtilization, metricCPUUtilization, metricDatabaseConnections, metricDatabaseConnections, metricFreeableMemory, metricFreeableMemory, metricFreeStorageSpace, metricFreeStorageSpace, metricReadIOPS, metricReadIOPS, metricWriteIOPS, metricWriteIOPS, onEvent, onEvent

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.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.rds.IDatabaseInstance

addProxy, getInstanceArn, grantConnect, metric, metric, metricCPUUtilization, metricCPUUtilization, metricDatabaseConnections, metricDatabaseConnections, metricFreeableMemory, metricFreeableMemory, metricFreeStorageSpace, metricFreeStorageSpace, metricReadIOPS, metricReadIOPS, metricWriteIOPS, metricWriteIOPS, onEvent, onEvent

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

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.services.secretsmanager.ISecretAttachmentTarget

asSecretAttachmentTarget

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

DatabaseInstanceReadReplica

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

DatabaseInstanceReadReplica

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

DatabaseInstanceReadReplica

@Stability(Stable)
public DatabaseInstanceReadReplica(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 DatabaseInstanceReadReplicaProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

setLogRetention

@Stability(Stable)
protected void setLogRetention()

getConnections

@Stability(Stable)
@NotNull
public Connections getConnections()

Access to network connections.

Specified by:

getConnections in interface IConnectable

Specified by:

getConnections in class DatabaseInstanceBase

getDbInstanceEndpointAddress

@Stability(Stable)
@NotNull
public String getDbInstanceEndpointAddress()

The instance endpoint address.

Specified by:

getDbInstanceEndpointAddress in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointAddress in class DatabaseInstanceBase

getDbInstanceEndpointPort

@Stability(Stable)
@NotNull
public String getDbInstanceEndpointPort()

The instance endpoint port.

Specified by:

getDbInstanceEndpointPort in interface IDatabaseInstance

Specified by:

getDbInstanceEndpointPort in class DatabaseInstanceBase

getInstanceEndpoint

@Stability(Stable)
@NotNull
public Endpoint getInstanceEndpoint()

The instance endpoint.

Specified by:

getInstanceEndpoint in interface IDatabaseInstance

Specified by:

getInstanceEndpoint in class DatabaseInstanceBase

getInstanceIdentifier

@Stability(Stable)
@NotNull
public String getInstanceIdentifier()

The instance identifier.

Specified by:

getInstanceIdentifier in interface IDatabaseInstance

Specified by:

getInstanceIdentifier in class DatabaseInstanceBase

getInstanceType

@Stability(Stable)
@NotNull
protected InstanceType getInstanceType()

getNewCfnProps

@Stability(Stable)
@NotNull
protected CfnDBInstanceProps getNewCfnProps()

getVpc

@Stability(Stable)
@NotNull
public IVpc getVpc()

The VPC where this database instance is deployed.

getEngine

@Stability(Stable)
@Nullable
public IInstanceEngine getEngine()

The engine of this database Instance.

May be not known for imported Instances if it wasn't provided explicitly, or for read replicas.

Specified by:

getEngine in interface IDatabaseInstance

Specified by:

getEngine in class DatabaseInstanceBase

getVpcPlacement

@Stability(Stable)
@Nullable
protected SubnetSelection getVpcPlacement()

getEnableIamAuthentication

@Stability(Stable)
@Nullable
protected Boolean getEnableIamAuthentication()

Specified by:

getEnableIamAuthentication in class DatabaseInstanceBase

setEnableIamAuthentication

@Stability(Stable)
protected void setEnableIamAuthentication(@Nullable
 Boolean value)

Specified by:

setEnableIamAuthentication in class DatabaseInstanceBase