software.amazon.jdbc

Class AllowedAndBlockedHosts

java.lang.Object

software.amazon.jdbc.AllowedAndBlockedHosts

public class AllowedAndBlockedHosts
extends java.lang.Object

Represents the allowed and blocked hosts for connections.

Constructor Summary

Constructors

Constructor and Description
AllowedAndBlockedHosts(@Nullable java.util.Set<java.lang.String> allowedHostIds, @Nullable java.util.Set<java.lang.String> blockedHostIds, @Nullable HostRole requiredRole) Constructs an AllowedAndBlockedHosts instance with the specified allowed and blocked host IDs.

Method Summary

Modifier and Type	Method and Description
@Nullable java.util.Set<java.lang.String>	getAllowedHostIds() Returns the set of allowed host IDs for connections.
@Nullable java.util.Set<java.lang.String>	getBlockedHostIds() Returns the set of blocked host IDs for connections.
@Nullable HostRole	getRequiredRole() Returns the required role of instances in the custom cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AllowedAndBlockedHosts

public AllowedAndBlockedHosts(@Nullable java.util.Set<java.lang.String> allowedHostIds,
                              @Nullable java.util.Set<java.lang.String> blockedHostIds,
                              @Nullable HostRole requiredRole)

Constructs an AllowedAndBlockedHosts instance with the specified allowed and blocked host IDs.

Parameters:

allowedHostIds - The set of allowed host IDs for connections. If null or empty, all host IDs that are not in blockedHostIds are allowed.

blockedHostIds - The set of blocked host IDs for connections. If null or empty, all host IDs in allowedHostIds are allowed. If allowedHostIds is also null or empty, there are no restrictions on which hosts are allowed.

requiredRole - The required role of instances in the custom cluster. Note that custom clusters with static member lists always route to all static members, even if the member is a writer and the custom endpoint is of type is READER, so there are never role requirements for static list custom clusters.

Method Detail

getAllowedHostIds

public @Nullable java.util.Set<java.lang.String> getAllowedHostIds()

Returns the set of allowed host IDs for connections. If null or empty, all host IDs that are not in blockedHostIds are allowed.

Returns:

the set of allowed host IDs for connections.

getBlockedHostIds

public @Nullable java.util.Set<java.lang.String> getBlockedHostIds()

Returns the set of blocked host IDs for connections. If null or empty, all host IDs in allowedHostIds are allowed. If allowedHostIds is also null or empty, there are no restrictions on which hosts are allowed.

Returns:

the set of blocked host IDs for connections.

getRequiredRole

public @Nullable HostRole getRequiredRole()

Returns the required role of instances in the custom cluster. Note that custom clusters with static member lists always route to all static members, even if the member is a writer and the custom endpoint is of type is READER, so there are never role requirements for static list custom clusters.

Returns:

the required role of instances in the custom endpoint, or null if there is no strict role requirement.