Menu
Amazon Lightsail
REST API Reference (API Version 2016-11-28)

InstancePortState

Describes the port state.

Contents

fromPort

The first port in the range.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 65535.

Required: No

protocol

The protocol being used. Can be one of the following.

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.

  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

Type: String

Valid Values: tcp | all | udp

Required: No

state

Specifies whether the instance port is open or closed.

Type: String

Valid Values: open | closed

Required: No

toPort

The last port in the range.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 65535.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: