Class: AWSCDK::RDS::CfnDBCluster::ReadEndpointProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::RDS::CfnDBCluster::ReadEndpointProperty

Defined in:

rds/cfn_db_cluster.rb

Overview

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-readendpoint.html

Instance Attribute Summary

• #address ⇒ String^? readonly

  The host address of the reader endpoint.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(address: nil) ⇒ ReadEndpointProperty constructor

  A new instance of ReadEndpointProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(address: nil) ⇒ ReadEndpointProperty

Returns a new instance of ReadEndpointProperty.

Parameters:

• address (String, nil) (defaults to: nil) —

  The host address of the reader endpoint.

# File 'rds/cfn_db_cluster.rb', line 1565

def initialize(address: nil)
  @address = address
  Jsii::Type.check_type(@address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "address") unless @address.nil?
end

Instance Attribute Details

#address ⇒ String^? (readonly)

The host address of the reader endpoint.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-readendpoint.html#cfn-rds-dbcluster-readendpoint-address

# File 'rds/cfn_db_cluster.rb', line 1574

def address
  @address
end

Class Method Details

.jsii_properties ⇒ Object

# File 'rds/cfn_db_cluster.rb', line 1576

def self.jsii_properties
  {
    :address => "address",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'rds/cfn_db_cluster.rb', line 1582

def to_jsii
  result = {}
  result.merge!({
    "address" => @address,
  })
  result.compact
end