class Endpoint
Language | Type name |
---|---|
![]() | aws_rfdk.Endpoint |
![]() | aws-rfdk » Endpoint |
Connection endpoint.
Consists of a combination of hostname, port, and transport protocol.
Initializer
new Endpoint(props: EndpointProps)
Parameters
- props
Endpoint
— The properties for the endpoint.Props
Constructs an Endpoint instance.
Properties
Name | Type | Description |
---|---|---|
hostname | string | The hostname of the endpoint. |
port | Port | The port of the endpoint. |
port | number | The port number of the endpoint. |
protocol | Protocol | The protocol of the endpoint. |
socket | string | The combination of "HOSTNAME:PORT" for this endpoint. |
hostname
Type:
string
The hostname of the endpoint.
port
Type:
Port
The port of the endpoint.
portNumber
Type:
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}.
protocol
Type:
Protocol
The protocol of the endpoint.
socketAddress
Type:
string
The combination of "HOSTNAME:PORT" for this endpoint.
Methods
Name | Description |
---|---|
port | Returns the port number as a string representation that can be used for embedding within other strings. |
AsString()
portpublic portAsString(): string
Returns
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.