software.amazon.awssdk.services.lightsail.model

Class InstancePortState

java.lang.Object

software.amazon.awssdk.services.lightsail.model.InstancePortState

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstancePortState.Builder,InstancePortState>

@Generated(value="software.amazon.awssdk:codegen")
public final class InstancePortState
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstancePortState.Builder,InstancePortState>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstancePortState.Builder

Method Summary

Modifier and Type	Method and Description
static InstancePortState.Builder	builder()
List<String>	cidrListAliases() An alias that defines access for a preconfigured range of IP addresses.
List<String>	cidrs() 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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	fromPort() The first port in a range of open ports on an instance.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCidrListAliases() For responses, this returns true if the service returned a value for the CidrListAliases property.
boolean	hasCidrs() For responses, this returns true if the service returned a value for the Cidrs property.
int	hashCode()
boolean	hasIpv6Cidrs() For responses, this returns true if the service returned a value for the Ipv6Cidrs property.
List<String>	ipv6Cidrs() 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.
NetworkProtocol	protocol() The IP protocol name.
String	protocolAsString() The IP protocol name.
List<SdkField<?>>	sdkFields()
static Class<? extends InstancePortState.Builder>	serializableBuilderClass()
PortState	state() Specifies whether the instance port is open or closed.
String	stateAsString() Specifies whether the instance port is open or closed.
InstancePortState.Builder	toBuilder()
Integer	toPort() The last port in a range of open ports on an instance.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fromPort

public final 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 IPv4 addresses. 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.

• ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

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 IPv4 addresses. 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.

• ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

toPort

public final 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 IPv4 addresses. 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.

• ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

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 IPv4 addresses. 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.

• ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.

protocol

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

If the service returns an enum value that is not available in the current SDK version, protocol will return NetworkProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

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

protocolAsString

public final String protocolAsString()

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.

If the service returns an enum value that is not available in the current SDK version, protocol will return NetworkProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

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

state

public final PortState state()

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

If the service returns an enum value that is not available in the current SDK version, state will return PortState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

See Also:

PortState

stateAsString

public final String stateAsString()

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

If the service returns an enum value that is not available in the current SDK version, state will return PortState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

See Also:

PortState

hasCidrs

public final boolean hasCidrs()

For responses, this returns true if the service returned a value for the Cidrs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

cidrs

public final List<String> cidrs()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCidrs() method.

Returns:

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.

hasIpv6Cidrs

public final boolean hasIpv6Cidrs()

For responses, this returns true if the service returned a value for the Ipv6Cidrs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

ipv6Cidrs

public final List<String> ipv6Cidrs()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpv6Cidrs() method.

Returns:

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.

hasCidrListAliases

public final boolean hasCidrListAliases()

For responses, this returns true if the service returned a value for the CidrListAliases property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

cidrListAliases

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCidrListAliases() method.

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.

toBuilder

public InstancePortState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstancePortState.Builder,InstancePortState>

builder

public static InstancePortState.Builder builder()

serializableBuilderClass

public static Class<? extends InstancePortState.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo