Interface Endpoint

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

Properties

directAccess? hostname? id ip? loadBalancer? name? port privateNetwork?

Properties

OptionaldirectAccess

directAccess?: DocumentDB.v1beta1.EndpointDirectAccessDetails

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.

Optionalhostname

hostname?: string

Hostname of the endpoint.

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

id

id: string

UUID of the endpoint.

Optionalip

ip?: string

IPv4 address of the endpoint.

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

OptionalloadBalancer

loadBalancer?: DocumentDB.v1beta1.EndpointLoadBalancerDetails

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.

Optionalname

name?: string

Name of the endpoint.

port

port: number

TCP port of the endpoint.

OptionalprivateNetwork

privateNetwork?: DocumentDB.v1beta1.EndpointPrivateNetworkDetails

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.

Settings

On This Page

Properties