public static interface CfnInstance.PortProperty
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnInstance.PortProperty.Builder
A builder for
CfnInstance.PortProperty |
static class |
CfnInstance.PortProperty.Jsii$Proxy
An implementation for
CfnInstance.PortProperty |
Modifier and Type | Method and Description |
---|---|
static CfnInstance.PortProperty.Builder |
builder() |
default java.lang.String |
getAccessDirection()
The access direction ( `inbound` or `outbound` ).
|
default java.lang.String |
getAccessFrom()
The location from which access is allowed.
|
default java.lang.String |
getAccessType()
The type of access ( `Public` or `Private` ).
|
default java.util.List<java.lang.String> |
getCidrListAliases()
An alias that defines access for a preconfigured range of IP addresses.
|
default java.util.List<java.lang.String> |
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 java.lang.String |
getCommonName()
The common name of the port information.
|
default java.lang.Number |
getFromPort()
The first port in a range of open ports on an instance.
|
default java.util.List<java.lang.String> |
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.
|
default java.lang.String |
getProtocol()
The IP protocol name.
|
default java.lang.Number |
getToPort()
The last port in a range of open ports on an instance.
|
default java.lang.String getAccessDirection()
Lightsail currently supports only
inbound
access direction.
default java.lang.String getAccessFrom()
For example, Anywhere (0.0.0.0/0)
, or Custom
if a specific IP address or range of IP addresses is allowed.
default java.lang.String getAccessType()
default java.util.List<java.lang.String> getCidrListAliases()
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.
default java.util.List<java.lang.String> getCidrs()
The
ipv6Cidrs
parameter lists the IPv6 addresses that are allowed to connect to an instance.
Examples:
192.0.2.44
, specify 192.0.2.44
or 192.0.2.44/32
.192.0.2.0
to 192.0.2.255
, specify 192.0.2.0/24
.default java.lang.String getCommonName()
default java.lang.Number getFromPort()
Allowed ports:
0
to 65535
8
as the fromPort
(ICMP type), and -1
as the toPort
(ICMP code), to enable ICMP Ping.128
as the fromPort
(ICMPv6 type), and 0
as toPort
(ICMPv6 code).default java.util.List<java.lang.String> getIpv6Cidrs()
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.
default java.lang.String getProtocol()
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 specify icmp
as the protocol
, you must specify the ICMP type using the fromPort
parameter, and ICMP code using the toPort
parameter.default java.lang.Number getToPort()
Allowed ports:
0
to 65535
8
as the fromPort
(ICMP type), and -1
as the toPort
(ICMP code), to enable ICMP Ping.128
as the fromPort
(ICMPv6 type), and 0
as toPort
(ICMPv6 code).static CfnInstance.PortProperty.Builder builder()
CfnInstance.PortProperty.Builder
of CfnInstance.PortProperty