Package software.amazon.awssdk.services.lightsail.model

Interface InstancePortInfo.Builder

    • Method Detail

      • fromPort

        InstancePortInfo.Builder fromPort​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • toPort

        InstancePortInfo.Builder toPort​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • protocol

        InstancePortInfo.Builder protocol​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NetworkProtocol, NetworkProtocol

      • protocol

        InstancePortInfo.Builder protocol​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NetworkProtocol, NetworkProtocol

      • accessFrom

        InstancePortInfo.Builder accessFrom​(String accessFrom)

        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.

        Parameters:
        accessFrom - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accessType

        InstancePortInfo.Builder accessType​(String accessType)

        The type of access (Public or Private).

        Parameters:
        accessType - The type of access (Public or Private).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PortAccessType, PortAccessType

      • commonName

        InstancePortInfo.Builder commonName​(String commonName)

        The common name of the port information.

        Parameters:
        commonName - The common name of the port information.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • accessDirection

        InstancePortInfo.Builder accessDirection​(String accessDirection)

        The access direction (inbound or outbound).

        Lightsail currently supports only inbound access direction.

        Parameters:
        accessDirection - The access direction (inbound or outbound).

        Lightsail currently supports only inbound access direction.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AccessDirection, AccessDirection

      • accessDirection

        InstancePortInfo.Builder accessDirection​(AccessDirection accessDirection)

        The access direction (inbound or outbound).

        Lightsail currently supports only inbound access direction.

        Parameters:
        accessDirection - The access direction (inbound or outbound).

        Lightsail currently supports only inbound access direction.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AccessDirection, AccessDirection

      • cidrs

        InstancePortInfo.Builder cidrs​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cidrs

        InstancePortInfo.Builder cidrs​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipv6Cidrs

        InstancePortInfo.Builder ipv6Cidrs​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ipv6Cidrs

        InstancePortInfo.Builder ipv6Cidrs​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cidrListAliases

        InstancePortInfo.Builder cidrListAliases​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cidrListAliases

        InstancePortInfo.Builder cidrListAliases​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.