AWS SDK for C++  1.9.158
AWS SDK for C++
Public Member Functions | List of all members
Aws::Lightsail::Model::PortInfo Class Reference

#include <PortInfo.h>

Public Member Functions

 PortInfo ()
 
 PortInfo (Aws::Utils::Json::JsonView jsonValue)
 
PortInfooperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetFromPort () const
 
bool FromPortHasBeenSet () const
 
void SetFromPort (int value)
 
PortInfoWithFromPort (int value)
 
int GetToPort () const
 
bool ToPortHasBeenSet () const
 
void SetToPort (int value)
 
PortInfoWithToPort (int value)
 
const NetworkProtocolGetProtocol () const
 
bool ProtocolHasBeenSet () const
 
void SetProtocol (const NetworkProtocol &value)
 
void SetProtocol (NetworkProtocol &&value)
 
PortInfoWithProtocol (const NetworkProtocol &value)
 
PortInfoWithProtocol (NetworkProtocol &&value)
 
const Aws::Vector< Aws::String > & GetCidrs () const
 
bool CidrsHasBeenSet () const
 
void SetCidrs (const Aws::Vector< Aws::String > &value)
 
void SetCidrs (Aws::Vector< Aws::String > &&value)
 
PortInfoWithCidrs (const Aws::Vector< Aws::String > &value)
 
PortInfoWithCidrs (Aws::Vector< Aws::String > &&value)
 
PortInfoAddCidrs (const Aws::String &value)
 
PortInfoAddCidrs (Aws::String &&value)
 
PortInfoAddCidrs (const char *value)
 
const Aws::Vector< Aws::String > & GetIpv6Cidrs () const
 
bool Ipv6CidrsHasBeenSet () const
 
void SetIpv6Cidrs (const Aws::Vector< Aws::String > &value)
 
void SetIpv6Cidrs (Aws::Vector< Aws::String > &&value)
 
PortInfoWithIpv6Cidrs (const Aws::Vector< Aws::String > &value)
 
PortInfoWithIpv6Cidrs (Aws::Vector< Aws::String > &&value)
 
PortInfoAddIpv6Cidrs (const Aws::String &value)
 
PortInfoAddIpv6Cidrs (Aws::String &&value)
 
PortInfoAddIpv6Cidrs (const char *value)
 
const Aws::Vector< Aws::String > & GetCidrListAliases () const
 
bool CidrListAliasesHasBeenSet () const
 
void SetCidrListAliases (const Aws::Vector< Aws::String > &value)
 
void SetCidrListAliases (Aws::Vector< Aws::String > &&value)
 
PortInfoWithCidrListAliases (const Aws::Vector< Aws::String > &value)
 
PortInfoWithCidrListAliases (Aws::Vector< Aws::String > &&value)
 
PortInfoAddCidrListAliases (const Aws::String &value)
 
PortInfoAddCidrListAliases (Aws::String &&value)
 
PortInfoAddCidrListAliases (const char *value)
 

Detailed Description

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

See Also:


AWS API Reference

Definition at line 35 of file PortInfo.h.

Constructor & Destructor Documentation

◆ PortInfo() [1/2]

Aws::Lightsail::Model::PortInfo::PortInfo ( )

◆ PortInfo() [2/2]

Aws::Lightsail::Model::PortInfo::PortInfo ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddCidrListAliases() [1/3]

PortInfo& Aws::Lightsail::Model::PortInfo::AddCidrListAliases ( Aws::String &&  value)
inline

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.

Definition at line 646 of file PortInfo.h.

◆ AddCidrListAliases() [2/3]

PortInfo& Aws::Lightsail::Model::PortInfo::AddCidrListAliases ( const Aws::String value)
inline

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.

Definition at line 638 of file PortInfo.h.

◆ AddCidrListAliases() [3/3]

PortInfo& Aws::Lightsail::Model::PortInfo::AddCidrListAliases ( const char *  value)
inline

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.

Definition at line 654 of file PortInfo.h.

◆ AddCidrs() [1/3]

PortInfo& Aws::Lightsail::Model::PortInfo::AddCidrs ( Aws::String &&  value)
inline

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.

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

Definition at line 457 of file PortInfo.h.

◆ AddCidrs() [2/3]

PortInfo& Aws::Lightsail::Model::PortInfo::AddCidrs ( const Aws::String value)
inline

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.

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

Definition at line 442 of file PortInfo.h.

◆ AddCidrs() [3/3]

PortInfo& Aws::Lightsail::Model::PortInfo::AddCidrs ( const char *  value)
inline

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.

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

Definition at line 472 of file PortInfo.h.

◆ AddIpv6Cidrs() [1/3]

PortInfo& Aws::Lightsail::Model::PortInfo::AddIpv6Cidrs ( Aws::String &&  value)
inline

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.

Definition at line 569 of file PortInfo.h.

◆ AddIpv6Cidrs() [2/3]

PortInfo& Aws::Lightsail::Model::PortInfo::AddIpv6Cidrs ( const Aws::String value)
inline

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.

Definition at line 557 of file PortInfo.h.

◆ AddIpv6Cidrs() [3/3]

PortInfo& Aws::Lightsail::Model::PortInfo::AddIpv6Cidrs ( const char *  value)
inline

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.

Definition at line 581 of file PortInfo.h.

◆ CidrListAliasesHasBeenSet()

bool Aws::Lightsail::Model::PortInfo::CidrListAliasesHasBeenSet ( ) const
inline

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.

Definition at line 598 of file PortInfo.h.

◆ CidrsHasBeenSet()

bool Aws::Lightsail::Model::PortInfo::CidrsHasBeenSet ( ) const
inline

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.

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

Definition at line 367 of file PortInfo.h.

◆ FromPortHasBeenSet()

bool Aws::Lightsail::Model::PortInfo::FromPortHasBeenSet ( ) const
inline

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.

Definition at line 76 of file PortInfo.h.

◆ GetCidrListAliases()

const Aws::Vector<Aws::String>& Aws::Lightsail::Model::PortInfo::GetCidrListAliases ( ) const
inline

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.

Definition at line 590 of file PortInfo.h.

◆ GetCidrs()

const Aws::Vector<Aws::String>& Aws::Lightsail::Model::PortInfo::GetCidrs ( ) const
inline

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.

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

Definition at line 352 of file PortInfo.h.

◆ GetFromPort()

int Aws::Lightsail::Model::PortInfo::GetFromPort ( ) const
inline

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.

Definition at line 59 of file PortInfo.h.

◆ GetIpv6Cidrs()

const Aws::Vector<Aws::String>& Aws::Lightsail::Model::PortInfo::GetIpv6Cidrs ( ) const
inline

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.

Definition at line 485 of file PortInfo.h.

◆ GetProtocol()

const NetworkProtocol& Aws::Lightsail::Model::PortInfo::GetProtocol ( ) const
inline

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.

Definition at line 206 of file PortInfo.h.

◆ GetToPort()

int Aws::Lightsail::Model::PortInfo::GetToPort ( ) const
inline

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.

Definition at line 128 of file PortInfo.h.

◆ Ipv6CidrsHasBeenSet()

bool Aws::Lightsail::Model::PortInfo::Ipv6CidrsHasBeenSet ( ) const
inline

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.

Definition at line 497 of file PortInfo.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Lightsail::Model::PortInfo::Jsonize ( ) const

◆ operator=()

PortInfo& Aws::Lightsail::Model::PortInfo::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ProtocolHasBeenSet()

bool Aws::Lightsail::Model::PortInfo::ProtocolHasBeenSet ( ) const
inline

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.

Definition at line 232 of file PortInfo.h.

◆ SetCidrListAliases() [1/2]

void Aws::Lightsail::Model::PortInfo::SetCidrListAliases ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 614 of file PortInfo.h.

◆ SetCidrListAliases() [2/2]

void Aws::Lightsail::Model::PortInfo::SetCidrListAliases ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 606 of file PortInfo.h.

◆ SetCidrs() [1/2]

void Aws::Lightsail::Model::PortInfo::SetCidrs ( Aws::Vector< Aws::String > &&  value)
inline

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.

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

Definition at line 397 of file PortInfo.h.

◆ SetCidrs() [2/2]

void Aws::Lightsail::Model::PortInfo::SetCidrs ( const Aws::Vector< Aws::String > &  value)
inline

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.

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

Definition at line 382 of file PortInfo.h.

◆ SetFromPort()

void Aws::Lightsail::Model::PortInfo::SetFromPort ( int  value)
inline

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.

Definition at line 93 of file PortInfo.h.

◆ SetIpv6Cidrs() [1/2]

void Aws::Lightsail::Model::PortInfo::SetIpv6Cidrs ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 521 of file PortInfo.h.

◆ SetIpv6Cidrs() [2/2]

void Aws::Lightsail::Model::PortInfo::SetIpv6Cidrs ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 509 of file PortInfo.h.

◆ SetProtocol() [1/2]

void Aws::Lightsail::Model::PortInfo::SetProtocol ( const NetworkProtocol value)
inline

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.

Definition at line 258 of file PortInfo.h.

◆ SetProtocol() [2/2]

void Aws::Lightsail::Model::PortInfo::SetProtocol ( NetworkProtocol &&  value)
inline

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.

Definition at line 284 of file PortInfo.h.

◆ SetToPort()

void Aws::Lightsail::Model::PortInfo::SetToPort ( int  value)
inline

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.

Definition at line 162 of file PortInfo.h.

◆ ToPortHasBeenSet()

bool Aws::Lightsail::Model::PortInfo::ToPortHasBeenSet ( ) const
inline

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.

Definition at line 145 of file PortInfo.h.

◆ WithCidrListAliases() [1/2]

PortInfo& Aws::Lightsail::Model::PortInfo::WithCidrListAliases ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 630 of file PortInfo.h.

◆ WithCidrListAliases() [2/2]

PortInfo& Aws::Lightsail::Model::PortInfo::WithCidrListAliases ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 622 of file PortInfo.h.

◆ WithCidrs() [1/2]

PortInfo& Aws::Lightsail::Model::PortInfo::WithCidrs ( Aws::Vector< Aws::String > &&  value)
inline

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.

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

Definition at line 427 of file PortInfo.h.

◆ WithCidrs() [2/2]

PortInfo& Aws::Lightsail::Model::PortInfo::WithCidrs ( const Aws::Vector< Aws::String > &  value)
inline

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.

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

Definition at line 412 of file PortInfo.h.

◆ WithFromPort()

PortInfo& Aws::Lightsail::Model::PortInfo::WithFromPort ( int  value)
inline

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.

Definition at line 110 of file PortInfo.h.

◆ WithIpv6Cidrs() [1/2]

PortInfo& Aws::Lightsail::Model::PortInfo::WithIpv6Cidrs ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 545 of file PortInfo.h.

◆ WithIpv6Cidrs() [2/2]

PortInfo& Aws::Lightsail::Model::PortInfo::WithIpv6Cidrs ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 533 of file PortInfo.h.

◆ WithProtocol() [1/2]

PortInfo& Aws::Lightsail::Model::PortInfo::WithProtocol ( const NetworkProtocol value)
inline

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.

Definition at line 310 of file PortInfo.h.

◆ WithProtocol() [2/2]

PortInfo& Aws::Lightsail::Model::PortInfo::WithProtocol ( NetworkProtocol &&  value)
inline

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.

Definition at line 336 of file PortInfo.h.

◆ WithToPort()

PortInfo& Aws::Lightsail::Model::PortInfo::WithToPort ( int  value)
inline

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.

Definition at line 179 of file PortInfo.h.


The documentation for this class was generated from the following file: