Endpoint

class aws_cdk.aws_docdb.Endpoint(address, port)

Bases: object

(experimental) Connection endpoint of a database cluster or instance.

Consists of a combination of hostname and port.

Stability

experimental

(experimental) Constructs an Endpoint instance.

Parameters
  • address (str) –

    • The hostname or address of the endpoint.

  • port (Union[int, float]) –

    • The port number of the endpoint.

Stability

experimental

Methods

port_as_string()

(experimental) 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.

Return type

str

Returns

An (un)resolved string representation of the endpoint’s port number

Stability

experimental

Attributes

hostname

(experimental) The hostname of the endpoint.

Stability

experimental

Return type

str

port

(experimental) 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 {@link Endpoint.portAsString}.

Stability

experimental

Return type

Union[int, float]

socket_address

PORT” for this endpoint.

Stability

experimental

Type

(experimental) The combination of “HOSTNAME

Return type

str