Interface CfnInstance.PortProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnInstance.PortProperty.Jsii$Proxy
- Enclosing class:
CfnInstance
Port
is a property of the Networking property. It describes information about ports for an instance.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.lightsail.*; PortProperty portProperty = PortProperty.builder() .accessDirection("accessDirection") .accessFrom("accessFrom") .accessType("accessType") .cidrListAliases(List.of("cidrListAliases")) .cidrs(List.of("cidrs")) .commonName("commonName") .fromPort(123) .ipv6Cidrs(List.of("ipv6Cidrs")) .protocol("protocol") .toPort(123) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnInstance.PortProperty
static final class
An implementation forCfnInstance.PortProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The access direction (inbound
oroutbound
).default String
The location from which access is allowed.default String
The type of access (Public
orPrivate
).An alias that defines access for a preconfigured range of IP addresses.getCidrs()
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.default String
The common name of the port information.default Number
The first port in a range of open ports on an instance.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.default String
The IP protocol name.default Number
The last port in a range of open ports on an instance.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAccessDirection
The access direction (inbound
oroutbound
).Lightsail currently supports only
inbound
access direction.- See Also:
-
getAccessFrom
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.- See Also:
-
getAccessType
The type of access (Public
orPrivate
).- See Also:
-
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.- See Also:
-
getCidrs
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.Examples:
- To allow the IP address
192.0.2.44
, specify192.0.2.44
or192.0.2.44/32
. - To allow the IP addresses
192.0.2.0
to192.0.2.255
, specify192.0.2.0/24
.
- See Also:
- To allow the IP address
-
getCommonName
The common name of the port information.- See Also:
-
getFromPort
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. - ICMPv6 - The ICMP type for IPv6 addresses. For example, specify
128
as thefromPort
(ICMPv6 type), and0
astoPort
(ICMPv6 code).
- See Also:
- TCP and UDP -
-
getIpv6Cidrs
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.- See Also:
-
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.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:
-
getToPort
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. - ICMPv6 - The ICMP code for IPv6 addresses. For example, specify
128
as thefromPort
(ICMPv6 type), and0
astoPort
(ICMPv6 code).
- See Also:
- TCP and UDP -
-
builder
- Returns:
- a
CfnInstance.PortProperty.Builder
ofCfnInstance.PortProperty
-