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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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>)


8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 8771

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

#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>)


8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 8771

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

#from_portInteger

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

Returns:

  • (Integer)


8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 8771

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

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

  • (String)


8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 8771

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

#stateString

Specifies whether the instance port is open or closed.

The port state for Lightsail instances is always open.

Returns:

  • (String)


8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 8771

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

#to_portInteger

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

Returns:

  • (Integer)


8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 8771

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