55 lines
1.7 KiB
TypeScript
55 lines
1.7 KiB
TypeScript
/**
|
|
* Connection endpoint of a database cluster or instance
|
|
*
|
|
* Consists of a combination of hostname and port.
|
|
*/
|
|
export declare class Endpoint {
|
|
/**
|
|
* The minimum port value
|
|
*/
|
|
private static readonly MIN_PORT;
|
|
/**
|
|
* The maximum port value
|
|
*/
|
|
private static readonly MAX_PORT;
|
|
/**
|
|
* Determines if a port is valid
|
|
*
|
|
* @param port: The port number
|
|
* @returns boolean whether the port is valid
|
|
*/
|
|
private static isValidPort;
|
|
/**
|
|
* The hostname of the endpoint
|
|
*/
|
|
readonly hostname: string;
|
|
/**
|
|
* The port number of the endpoint.
|
|
*
|
|
* This can potentially be a CDK token. If you need to embed the port in a string (e.g. instance user data script),
|
|
* use `Endpoint.portAsString`.
|
|
*/
|
|
readonly port: number;
|
|
/**
|
|
* Constructs an Endpoint instance.
|
|
*
|
|
* @param address - The hostname or address of the endpoint
|
|
* @param port - The port number of the endpoint
|
|
*/
|
|
constructor(address: string, port: number);
|
|
/**
|
|
* The combination of ``HOSTNAME:PORT`` for this endpoint.
|
|
*/
|
|
get socketAddress(): string;
|
|
/**
|
|
* Returns the port number as a string representation that can be used for embedding within other strings.
|
|
*
|
|
* This is intended to deal with CDK's token system. Numeric CDK tokens are not expanded when their string
|
|
* representation is embedded in a string. This function returns the port either as an unresolved string token or
|
|
* as a resolved string representation of the port value.
|
|
*
|
|
* @returns {string} An (un)resolved string representation of the endpoint's port number
|
|
*/
|
|
portAsString(): string;
|
|
}
|