Class InstancePortInfo
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InstancePortInfo.Builder,
InstancePortInfo>
Describes information about ports for an Amazon Lightsail instance.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AccessDirection
The access direction (inbound
oroutbound
).final String
The access direction (inbound
oroutbound
).final String
The location from which access is allowed.final PortAccessType
The type of access (Public
orPrivate
).final String
The type of access (Public
orPrivate
).static InstancePortInfo.Builder
builder()
An alias that defines access for a preconfigured range of IP addresses.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.final String
The common name of the port information.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
fromPort()
The first port in a range of open ports on an instance.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CidrListAliases property.final boolean
hasCidrs()
For responses, this returns true if the service returned a value for the Cidrs property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Ipv6Cidrs property.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.final NetworkProtocol
protocol()
The IP protocol name.final String
The IP protocol name.static Class
<? extends InstancePortInfo.Builder> Take this object and create a builder that contains all of the current property values of this object.final Integer
toPort()
The last port in a range of open ports on an instance.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fromPort
The first port in a range of open ports on an instance.
Allowed ports:
-
TCP and UDP -
0
to65535
-
ICMP - The ICMP type for IPv4 addresses. For example, specify
8
as thefromPort
(ICMP type), and-1
as 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
128
as thefromPort
(ICMPv6 type), and0
astoPort
(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
to65535
-
ICMP - The ICMP type for IPv4 addresses. For example, specify
8
as thefromPort
(ICMP type), and-1
as 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
128
as thefromPort
(ICMPv6 type), and0
astoPort
(ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.
-
-
-
toPort
The last port in a range of open ports on an instance.
Allowed ports:
-
TCP and UDP -
0
to65535
-
ICMP - The ICMP code for IPv4 addresses. For example, specify
8
as thefromPort
(ICMP type), and-1
as 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
128
as thefromPort
(ICMPv6 type), and0
astoPort
(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
to65535
-
ICMP - The ICMP code for IPv4 addresses. For example, specify
8
as thefromPort
(ICMP type), and-1
as 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
128
as thefromPort
(ICMPv6 type), and0
astoPort
(ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6.
-
-
-
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 specifyicmp
as theprotocol
, you must specify the ICMP type using thefromPort
parameter, and ICMP code using thetoPort
parameter.
If the service returns an enum value that is not available in the current SDK version,
protocol
will returnNetworkProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- 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 specifyicmp
as theprotocol
, you must specify the ICMP type using thefromPort
parameter, and ICMP code using thetoPort
parameter.
-
- See Also:
-
-
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 specifyicmp
as theprotocol
, you must specify the ICMP type using thefromPort
parameter, and ICMP code using thetoPort
parameter.
If the service returns an enum value that is not available in the current SDK version,
protocol
will returnNetworkProtocol.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprotocolAsString()
.- 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 specifyicmp
as theprotocol
, you must specify the ICMP type using thefromPort
parameter, and ICMP code using thetoPort
parameter.
-
- See Also:
-
-
accessFrom
The location from which access is allowed. For example,
Anywhere (0.0.0.0/0)
, orCustom
if a specific IP address or range of IP addresses is allowed.- Returns:
- The location from which access is allowed. For example,
Anywhere (0.0.0.0/0)
, orCustom
if a specific IP address or range of IP addresses is allowed.
-
accessType
The type of access (
Public
orPrivate
).If the service returns an enum value that is not available in the current SDK version,
accessType
will returnPortAccessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessTypeAsString()
.- Returns:
- The type of access (
Public
orPrivate
). - See Also:
-
accessTypeAsString
The type of access (
Public
orPrivate
).If the service returns an enum value that is not available in the current SDK version,
accessType
will returnPortAccessType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessTypeAsString()
.- Returns:
- The type of access (
Public
orPrivate
). - See Also:
-
commonName
The common name of the port information.
- Returns:
- The common name of the port information.
-
accessDirection
The access direction (
inbound
oroutbound
).Lightsail currently supports only
inbound
access direction.If the service returns an enum value that is not available in the current SDK version,
accessDirection
will returnAccessDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessDirectionAsString()
.- Returns:
- The access direction (
inbound
oroutbound
).Lightsail currently supports only
inbound
access direction. - See Also:
-
accessDirectionAsString
The access direction (
inbound
oroutbound
).Lightsail currently supports only
inbound
access direction.If the service returns an enum value that is not available in the current SDK version,
accessDirection
will returnAccessDirection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromaccessDirectionAsString()
.- Returns:
- The access direction (
inbound
oroutbound
).Lightsail currently supports only
inbound
access direction. - See Also:
-
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<InstancePortInfo.Builder,
InstancePortInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-