InstancePortState
¶
Source code in docs_src/capo_lightsail/types/instance_port_state.py
cidr_list_aliases
instance-attribute
¶
cidr_list_aliases: NotRequired[StringList]
An alias that defines access for a preconfigured range of IP addresses.
The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
cidrs
instance-attribute
¶
cidrs: NotRequired[StringList]
The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.
The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
from_port
instance-attribute
¶
from_port: Port
The first port in a range of open ports on an instance.
Allowed ports:
-
TCP and UDP -
0to65535 -
ICMP - The ICMP type for IPv4 addresses. For example, specify
8as thefromPort(ICMP type), and-1as thetoPort(ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. -
ICMPv6 - The ICMP type for IPv6 addresses. For example, specify
128as thefromPort(ICMPv6 type), and0astoPort(ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.
ipv6_cidrs
instance-attribute
¶
ipv6_cidrs: NotRequired[StringList]
The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.
The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance.
For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.
protocol
instance-attribute
¶
protocol: NotRequired[NetworkProtocol]
The IP protocol name.
The name 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. -
icmp- Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specifyicmpas theprotocol, you must specify the ICMP type using thefromPortparameter, and ICMP code using thetoPortparameter. -
icmp6- Internet Control Message Protocol (ICMP) for IPv6. When you specifyicmp6as theprotocol, you must specify the ICMP type using thefromPortparameter, and ICMP code using thetoPortparameter.
state
instance-attribute
¶
state: NotRequired[PortState]
Specifies whether the instance port is open or closed.
The port state for Lightsail instances is always open.
to_port
instance-attribute
¶
to_port: Port
The last port in a range of open ports on an instance.
Allowed ports:
-
TCP and UDP -
0to65535 -
ICMP - The ICMP code for IPv4 addresses. For example, specify
8as thefromPort(ICMP type), and-1as thetoPort(ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia. -
ICMPv6 - The ICMP code for IPv6 addresses. For example, specify
128as thefromPort(ICMPv6 type), and0astoPort(ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.