interface Endpoint {
    directAccess?: RDB.v1.EndpointDirectAccessDetails;
    hostname?: string;
    id: string;
    ip?: string;
    loadBalancer?: RDB.v1.EndpointLoadBalancerDetails;
    name?: string;
    port: number;
    privateNetwork?: RDB.v1.EndpointPrivateNetworkDetails;
}

Properties

Direct access details. Public endpoint reserved for Read Replicas. One per Read Replica.

One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', 'directAccess' could be set.

hostname?: string

Hostname of the endpoint.

One-of ('address'): at most one of 'ip', 'hostname' could be set.

id: string

UUID of the endpoint.

ip?: string

IPv4 address of the endpoint.

One-of ('address'): at most one of 'ip', 'hostname' could be set.

Load balancer details. Public endpoint for Database Instance which is systematically present. One per Database Instance.

One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', 'directAccess' could be set.

name?: string

Name of the endpoint.

port: number

TCP port of the endpoint.

Private Network details. One maximum per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated).

One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', 'directAccess' could be set.