com.amazonaws.services.lightsail.model

Class PortInfo

java.lang.Object

com.amazonaws.services.lightsail.model.PortInfo

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PortInfo
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes ports to open on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PortInfo()

Method Summary

Modifier and Type	Method and Description
PortInfo	clone()
boolean	equals(Object obj)
List<String>	getCidrListAliases() An alias that defines access for a preconfigured range of IP addresses.
List<String>	getCidrs() The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol.
Integer	getFromPort() The first port in a range of open ports on an instance.
String	getProtocol() The IP protocol name.
Integer	getToPort() The last port in a range of open ports on an instance.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCidrListAliases(Collection<String> cidrListAliases) An alias that defines access for a preconfigured range of IP addresses.
void	setCidrs(Collection<String> cidrs) The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol.
void	setFromPort(Integer fromPort) The first port in a range of open ports on an instance.
void	setProtocol(NetworkProtocol protocol) The IP protocol name.
void	setProtocol(String protocol) The IP protocol name.
void	setToPort(Integer toPort) The last port in a range of open ports on an instance.
String	toString() Returns a string representation of this object.
PortInfo	withCidrListAliases(Collection<String> cidrListAliases) An alias that defines access for a preconfigured range of IP addresses.
PortInfo	withCidrListAliases(String... cidrListAliases) An alias that defines access for a preconfigured range of IP addresses.
PortInfo	withCidrs(Collection<String> cidrs) The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol.
PortInfo	withCidrs(String... cidrs) The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol.
PortInfo	withFromPort(Integer fromPort) The first port in a range of open ports on an instance.
PortInfo	withProtocol(NetworkProtocol protocol) The IP protocol name.
PortInfo	withProtocol(String protocol) The IP protocol name.
PortInfo	withToPort(Integer toPort) The last port in a range of open ports on an instance.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PortInfo

public PortInfo()

Method Detail

setFromPort

public void setFromPort(Integer fromPort)

The first port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

Parameters:

fromPort - The first port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

getFromPort

public Integer getFromPort()

The first port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

Returns:

The first port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

withFromPort

public PortInfo withFromPort(Integer fromPort)

The first port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

Parameters:

fromPort - The first port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP type. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

Returns:

Returns a reference to this object so that method calls can be chained together.

setToPort

public void setToPort(Integer toPort)

The last port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

Parameters:

toPort - The last port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

getToPort

public Integer getToPort()

The last port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

Returns:

The last port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

withToPort

public PortInfo withToPort(Integer toPort)

The last port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

Parameters:

toPort - The last port in a range of open ports on an instance.

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - The ICMP code. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProtocol

public void setProtocol(String protocol)

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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

Parameters:

protocol - 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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

See Also:

NetworkProtocol

getProtocol

public String getProtocol()

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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

Returns:

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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

See Also:

NetworkProtocol

withProtocol

public PortInfo withProtocol(String protocol)

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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

Parameters:

protocol - 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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NetworkProtocol

setProtocol

public void setProtocol(NetworkProtocol protocol)

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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

Parameters:

protocol - 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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

See Also:

NetworkProtocol

withProtocol

public PortInfo withProtocol(NetworkProtocol protocol)

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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

Parameters:

protocol - 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 specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NetworkProtocol

getCidrs

public List<String> getCidrs()

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:

• To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

• To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

Returns:

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:

• To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

• To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

setCidrs

public void setCidrs(Collection<String> cidrs)

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:

• To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

• To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

Parameters:

cidrs - The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:

• To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

• To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

withCidrs

public PortInfo withCidrs(String... cidrs)

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:

• To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

• To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

NOTE: This method appends the values to the existing list (if any). Use setCidrs(java.util.Collection) or withCidrs(java.util.Collection) if you want to override the existing values.

Parameters:

cidrs - The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:

• To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

• To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

Returns:

Returns a reference to this object so that method calls can be chained together.

withCidrs

public PortInfo withCidrs(Collection<String> cidrs)

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:

• To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

• To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

Parameters:

cidrs - The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

Examples:

• To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.

• To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCidrListAliases

public List<String> getCidrListAliases()

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.

Returns:

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.

setCidrListAliases

public void setCidrListAliases(Collection<String> cidrListAliases)

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.

Parameters:

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

withCidrListAliases

public PortInfo withCidrListAliases(String... cidrListAliases)

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.

NOTE: This method appends the values to the existing list (if any). Use setCidrListAliases(java.util.Collection) or withCidrListAliases(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withCidrListAliases

public PortInfo withCidrListAliases(Collection<String> cidrListAliases)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PortInfo clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.