software.amazon.awscdk.services.rds

Interface CfnDBCluster.ReadEndpointProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBCluster.ReadEndpointProperty.Jsii$Proxy

Enclosing class:

CfnDBCluster

@Stability(value=Stable)
public static interface CfnDBCluster.ReadEndpointProperty
extends software.amazon.jsii.JsiiSerializable

The `ReadEndpoint` return value specifies the reader endpoint for the DB cluster.

The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

For more information about Aurora endpoints, see Amazon Aurora connection management in the Amazon Aurora User Guide .

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.rds.*;
 ReadEndpointProperty readEndpointProperty = ReadEndpointProperty.builder()
         .address("address")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDBCluster.ReadEndpointProperty.Builder A builder for CfnDBCluster.ReadEndpointProperty
static class	CfnDBCluster.ReadEndpointProperty.Jsii$Proxy An implementation for CfnDBCluster.ReadEndpointProperty

Method Summary

Modifier and Type	Method and Description
static CfnDBCluster.ReadEndpointProperty.Builder	builder()
default String	getAddress() The host address of the reader endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAddress

@Stability(value=Stable)
 @Nullable
default String getAddress()

The host address of the reader endpoint.

builder

@Stability(value=Stable)
static CfnDBCluster.ReadEndpointProperty.Builder builder()

Returns:

a CfnDBCluster.ReadEndpointProperty.Builder of CfnDBCluster.ReadEndpointProperty