You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lightsail::Types::InstancePortInfo

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes information about ports for an Amazon Lightsail instance.

Instance Attribute Summary collapse

Instance Attribute Details

#access_directionString

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

Possible values:

  • inbound
  • outbound

Returns:

  • (String)

    The access direction (inbound or outbound).

#access_fromString

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:

  • (String)

    The location from which access is allowed.

#access_typeString

The type of access (Public or Private).

Possible values:

  • Public
  • Private

Returns:

  • (String)

    The type of access (Public or Private).

#cidr_list_aliasesArray<String>

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:

  • (Array<String>)

    An alias that defines access for a preconfigured range of IP addresses.

#cidrsArray<String>

The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol. Lightsail supports IPv4 addresses.

For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia.

Returns:

  • (Array<String>)

    The IP address, or range of IP addresses in CIDR notation, that are allowed to connect to an instance through the ports, and the protocol.

#common_nameString

The common name of the port information.

Returns:

  • (String)

    The common name of the port information.

#from_portInteger

The first port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - 8 (to configure Ping)

    Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Returns:

  • (Integer)

    The first port in a range of open ports on an instance.

#protocolString

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.

    Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Returns:

  • (String)

    The IP protocol name.

#to_portInteger

The last port in a range of open ports on an instance.

Allowed ports:

  • TCP and UDP - 0 to 65535

  • ICMP - -1 (to configure Ping)

    Ping is the only communication supported through the ICMP protocol in Lightsail. To configure ping, specify the fromPort parameter as 8, and the toPort parameter as -1.

Returns:

  • (Integer)

    The last port in a range of open ports on an instance.