CfnInstance.PortProperty

All Known Implementing Classes:: CfnInstance.PortProperty.Jsii$Proxy

Enclosing class:: CfnInstance

public static interface CfnInstance.PortProperty

`Port` is a property of the [Networking](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lightsail-instance-networking.html) 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();

Nested Class Summary

Nested Classes
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`

Method Summary

All Methods Static Methods Instance Methods Default Methods
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.

- Method Detail
  - getAccessDirection
```
default java.lang.String getAccessDirection()
```
    The access direction ( `inbound` or `outbound` ).
    
    Lightsail currently supports only inbound access direction.
  - getAccessFrom
```
default java.lang.String getAccessFrom()
```
    The location from which access is allowed.
    For example, Anywhere (0.0.0.0/0) , or Custom if a specific IP address or range of IP addresses is allowed.
  - getAccessType
```
default java.lang.String getAccessType()
```
    The type of access ( `Public` or `Private` ).
  - getCidrListAliases
```
default java.util.List<java.lang.String> 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.
  - getCidrs
```
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.
    
    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 , specify 192.0.2.44 or 192.0.2.44/32 .
    - To allow the IP addresses 192.0.2.0 to 192.0.2.255 , specify 192.0.2.0/24 .
  - getCommonName
```
default java.lang.String getCommonName()
```
    The common name of the port information.
  - getFromPort
```
default java.lang.Number getFromPort()
```
    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.
    - ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code).
  - getIpv6Cidrs
```
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.
    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.
  - getProtocol
```
default java.lang.String 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 specify icmp as the protocol , you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.
  - getToPort
```
default java.lang.Number getToPort()
```
    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.
    - ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code).
  - builder
```
static CfnInstance.PortProperty.Builder builder()
```
    Returns:
    
    a CfnInstance.PortProperty.Builder of CfnInstance.PortProperty

Interface CfnInstance.PortProperty

Nested Class Summary

Method Summary

Method Detail

getAccessDirection

getAccessFrom

getAccessType

getCidrListAliases

getCidrs

getCommonName

getFromPort

getIpv6Cidrs

getProtocol

getToPort

builder