@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.
Modifier and Type | Class and Description |
---|---|
static interface |
InstancePortState.Builder |
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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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()
Returns true if the CidrListAliases property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasCidrs()
Returns true if the Cidrs property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasIpv6Cidrs()
Returns true if the Ipv6Cidrs property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
Integer |
toPort()
The last port in a range of open ports on an instance.
|
String |
toString()
Returns a string representation of this object.
|
copy
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.
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.
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.
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.
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()
.
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.
NetworkProtocol
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()
.
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.
NetworkProtocol
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()
.
open
or closed
.
The port state for Lightsail instances is always open
.
PortState
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()
.
open
or closed
.
The port state for Lightsail instances is always open
.
PortState
public final boolean hasCidrs()
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.
You can use hasCidrs()
to see if a value was sent in this field.
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.
public final boolean hasIpv6Cidrs()
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.
You can use hasIpv6Cidrs()
to see if a value was sent in this field.
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.
public final boolean hasCidrListAliases()
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.
You can use hasCidrListAliases()
to see if a value was sent in this field.
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.
public InstancePortState.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<InstancePortState.Builder,InstancePortState>
public static InstancePortState.Builder builder()
public static Class<? extends InstancePortState.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()