Endpoint

class aws_rfdk.Endpoint(*, address, port, protocol=None)

Bases: object

Connection endpoint.

Consists of a combination of hostname, port, and transport protocol.

Constructs an Endpoint instance.

Parameters

address (str) – The address (either an IP or hostname) of the endpoint.
port (Union[int, float]) – The port number of the endpoint.
protocol (Optional[Protocol]) – The transport protocol of the endpoint. Default: TCP

Methods

port_as_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.

Return type: str
Returns: An (un)resolved string representation of the endpoint’s port number

Attributes

hostname

The hostname of the endpoint.

Return type: str

port

The port of the endpoint.

Return type: Port

port_number

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}.

Return type: Union[int, float]

protocol

The protocol of the endpoint.

Return type: Protocol

socket_address

PORT” for this endpoint.

Type: The combination of “HOSTNAME
Return type: str