Class: Aws::Lightsail::Types::InstancePortState

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::InstancePortState

Includes:

Structure

Defined in:

lib/aws-sdk-lightsail/types.rb

Overview

Describes open ports on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cidr_list_aliases ⇒ Array<String>

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

• #cidrs ⇒ Array<String>

  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.

• #from_port ⇒ Integer

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

• #ipv6_cidrs ⇒ Array<String>

  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.

• #protocol ⇒ String

  The IP protocol name.

• #state ⇒ String

  Specifies whether the instance port is ‘open` or `closed`.

• #to_port ⇒ Integer

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

Instance Attribute Details

#cidr_list_aliases ⇒ Array<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>)

# File 'lib/aws-sdk-lightsail/types.rb', line 10665

class InstancePortState < Struct.new(
  :from_port,
  :to_port,
  :protocol,
  :state,
  :cidrs,
  :ipv6_cidrs,
  :cidr_list_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#cidrs ⇒ Array<String>

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.

<note markdown=“1”> The ‘ipv6Cidrs` parameter lists the IPv6 addresses that are allowed to connect to an instance.

</note>

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

[1]: en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation

Returns:

• (Array<String>)

# File 'lib/aws-sdk-lightsail/types.rb', line 10665

class InstancePortState < Struct.new(
  :from_port,
  :to_port,
  :protocol,
  :state,
  :cidrs,
  :ipv6_cidrs,
  :cidr_list_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#from_port ⇒ Integer

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].

[1]: en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages [2]: en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6

Returns:

• (Integer)

# File 'lib/aws-sdk-lightsail/types.rb', line 10665

class InstancePortState < Struct.new(
  :from_port,
  :to_port,
  :protocol,
  :state,
  :cidrs,
  :ipv6_cidrs,
  :cidr_list_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#ipv6_cidrs ⇒ Array<String>

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.

<note markdown=“1”> The ‘cidrs` parameter lists the IPv4 addresses that are allowed to connect to an instance.

</note>

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

[1]: en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation

Returns:

• (Array<String>)

# File 'lib/aws-sdk-lightsail/types.rb', line 10665

class InstancePortState < Struct.new(
  :from_port,
  :to_port,
  :protocol,
  :state,
  :cidrs,
  :ipv6_cidrs,
  :cidr_list_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

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.

• ‘icmp6` - Internet Control Message Protocol (ICMP) for IPv6. When you specify `icmp6` as the `protocol`, you must specify the ICMP type using the `fromPort` parameter, and ICMP code using the `toPort` parameter.

[1]: en.wikipedia.org/wiki/Transport_layer

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 10665

class InstancePortState < Struct.new(
  :from_port,
  :to_port,
  :protocol,
  :state,
  :cidrs,
  :ipv6_cidrs,
  :cidr_list_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

Specifies whether the instance port is ‘open` or `closed`.

<note markdown=“1”> The port state for Lightsail instances is always ‘open`.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 10665

class InstancePortState < Struct.new(
  :from_port,
  :to_port,
  :protocol,
  :state,
  :cidrs,
  :ipv6_cidrs,
  :cidr_list_aliases)
  SENSITIVE = []
  include Aws::Structure
end

#to_port ⇒ Integer

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].

[1]: en.wikipedia.org/wiki/Internet_Control_Message_Protocol#Control_messages [2]: en.wikipedia.org/wiki/Internet_Control_Message_Protocol_for_IPv6

Returns:

• (Integer)

# File 'lib/aws-sdk-lightsail/types.rb', line 10665

class InstancePortState < Struct.new(
  :from_port,
  :to_port,
  :protocol,
  :state,
  :cidrs,
  :ipv6_cidrs,
  :cidr_list_aliases)
  SENSITIVE = []
  include Aws::Structure
end