com.amazonaws.services.lightsail.model

Class InstancePortState

java.lang.Object

com.amazonaws.services.lightsail.model.InstancePortState

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Describes open ports 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
InstancePortState()

Method Summary

Modifier and Type	Method and Description
InstancePortState	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.
String	getState() Specifies whether the instance port is open or closed.
Integer	getToPort() The last port in a range of open ports on an instance.
int	hashCode()
void	marshall(ProtocolMarshaller 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	setState(PortState state) Specifies whether the instance port is open or closed.
void	setState(String state) Specifies whether the instance port is open or closed.
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.
InstancePortState	withCidrListAliases(Collection<String> cidrListAliases) An alias that defines access for a preconfigured range of IP addresses.
InstancePortState	withCidrListAliases(String... cidrListAliases) An alias that defines access for a preconfigured range of IP addresses.
InstancePortState	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.
InstancePortState	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.
InstancePortState	withFromPort(Integer fromPort) The first port in a range of open ports on an instance.
InstancePortState	withProtocol(NetworkProtocol protocol) The IP protocol name.
InstancePortState	withProtocol(String protocol) The IP protocol name.
InstancePortState	withState(PortState state) Specifies whether the instance port is open or closed.
InstancePortState	withState(String state) Specifies whether the instance port is open or closed.
InstancePortState	withToPort(Integer toPort) The last port in a range of open ports on an instance.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InstancePortState

public InstancePortState()

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 - 8 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Parameters:

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

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - 8 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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 - 8 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Returns:

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

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - 8 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

withFromPort

public InstancePortState withFromPort(Integer fromPort)

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

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - 8 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Parameters:

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

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - 8 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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 - -1 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Parameters:

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

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - -1 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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 - -1 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Returns:

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

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - -1 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

withToPort

public InstancePortState withToPort(Integer toPort)

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

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - -1 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Parameters:

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

Allowed ports:

• TCP and UDP - 0 to 65535

• ICMP - -1 (to configure Ping)

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

See Also:

NetworkProtocol

withProtocol

public InstancePortState 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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

See Also:

NetworkProtocol

withProtocol

public InstancePortState 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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

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.

  Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Returns:

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

See Also:

NetworkProtocol

setState

public void setState(String state)

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

Parameters:

state - Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

See Also:

PortState

getState

public String getState()

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

Returns:

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

See Also:

PortState

withState

public InstancePortState withState(String state)

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

Parameters:

state - Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

Returns:

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

See Also:

PortState

setState

public void setState(PortState state)

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

Parameters:

state - Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

See Also:

PortState

withState

public InstancePortState withState(PortState state)

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

Parameters:

state - Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

Returns:

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

See Also:

PortState

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.

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.

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.

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.

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

withCidrs

public InstancePortState 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.

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.

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

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.

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 InstancePortState 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 InstancePortState 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 InstancePortState clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo