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

#include <InstancePortInfo.h>

Public Member Functions

 InstancePortInfo ()
 
 InstancePortInfo (Aws::Utils::Json::JsonView jsonValue)
 
InstancePortInfooperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetFromPort () const
 
bool FromPortHasBeenSet () const
 
void SetFromPort (int value)
 
InstancePortInfoWithFromPort (int value)
 
int GetToPort () const
 
bool ToPortHasBeenSet () const
 
void SetToPort (int value)
 
InstancePortInfoWithToPort (int value)
 
const NetworkProtocolGetProtocol () const
 
bool ProtocolHasBeenSet () const
 
void SetProtocol (const NetworkProtocol &value)
 
void SetProtocol (NetworkProtocol &&value)
 
InstancePortInfoWithProtocol (const NetworkProtocol &value)
 
InstancePortInfoWithProtocol (NetworkProtocol &&value)
 
const Aws::StringGetAccessFrom () const
 
bool AccessFromHasBeenSet () const
 
void SetAccessFrom (const Aws::String &value)
 
void SetAccessFrom (Aws::String &&value)
 
void SetAccessFrom (const char *value)
 
InstancePortInfoWithAccessFrom (const Aws::String &value)
 
InstancePortInfoWithAccessFrom (Aws::String &&value)
 
InstancePortInfoWithAccessFrom (const char *value)
 
const PortAccessTypeGetAccessType () const
 
bool AccessTypeHasBeenSet () const
 
void SetAccessType (const PortAccessType &value)
 
void SetAccessType (PortAccessType &&value)
 
InstancePortInfoWithAccessType (const PortAccessType &value)
 
InstancePortInfoWithAccessType (PortAccessType &&value)
 
const Aws::StringGetCommonName () const
 
bool CommonNameHasBeenSet () const
 
void SetCommonName (const Aws::String &value)
 
void SetCommonName (Aws::String &&value)
 
void SetCommonName (const char *value)
 
InstancePortInfoWithCommonName (const Aws::String &value)
 
InstancePortInfoWithCommonName (Aws::String &&value)
 
InstancePortInfoWithCommonName (const char *value)
 
const AccessDirectionGetAccessDirection () const
 
bool AccessDirectionHasBeenSet () const
 
void SetAccessDirection (const AccessDirection &value)
 
void SetAccessDirection (AccessDirection &&value)
 
InstancePortInfoWithAccessDirection (const AccessDirection &value)
 
InstancePortInfoWithAccessDirection (AccessDirection &&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)
 
InstancePortInfoWithCidrs (const Aws::Vector< Aws::String > &value)
 
InstancePortInfoWithCidrs (Aws::Vector< Aws::String > &&value)
 
InstancePortInfoAddCidrs (const Aws::String &value)
 
InstancePortInfoAddCidrs (Aws::String &&value)
 
InstancePortInfoAddCidrs (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)
 
InstancePortInfoWithIpv6Cidrs (const Aws::Vector< Aws::String > &value)
 
InstancePortInfoWithIpv6Cidrs (Aws::Vector< Aws::String > &&value)
 
InstancePortInfoAddIpv6Cidrs (const Aws::String &value)
 
InstancePortInfoAddIpv6Cidrs (Aws::String &&value)
 
InstancePortInfoAddIpv6Cidrs (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)
 
InstancePortInfoWithCidrListAliases (const Aws::Vector< Aws::String > &value)
 
InstancePortInfoWithCidrListAliases (Aws::Vector< Aws::String > &&value)
 
InstancePortInfoAddCidrListAliases (const Aws::String &value)
 
InstancePortInfoAddCidrListAliases (Aws::String &&value)
 
InstancePortInfoAddCidrListAliases (const char *value)
 

Detailed Description

Describes information about ports for an Amazon Lightsail instance.

See Also:

AWS API Reference

Definition at line 36 of file InstancePortInfo.h.

Constructor & Destructor Documentation

◆ InstancePortInfo() [1/2]

Aws::Lightsail::Model::InstancePortInfo::InstancePortInfo ( )

◆ InstancePortInfo() [2/2]

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

Member Function Documentation

◆ AccessDirectionHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::AccessDirectionHasBeenSet ( ) const
inline

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

Definition at line 481 of file InstancePortInfo.h.

◆ AccessFromHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::AccessFromHasBeenSet ( ) const
inline

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.

Definition at line 352 of file InstancePortInfo.h.

◆ AccessTypeHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::AccessTypeHasBeenSet ( ) const
inline

The type of access (Public or Private).

Definition at line 405 of file InstancePortInfo.h.

◆ AddCidrListAliases() [1/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 783 of file InstancePortInfo.h.

◆ AddCidrListAliases() [2/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 775 of file InstancePortInfo.h.

◆ AddCidrListAliases() [3/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 791 of file InstancePortInfo.h.

◆ AddCidrs() [1/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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.

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

Definition at line 598 of file InstancePortInfo.h.

◆ AddCidrs() [2/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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.

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

Definition at line 587 of file InstancePortInfo.h.

◆ AddCidrs() [3/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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.

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

Definition at line 609 of file InstancePortInfo.h.

◆ AddIpv6Cidrs() [1/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 706 of file InstancePortInfo.h.

◆ AddIpv6Cidrs() [2/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 694 of file InstancePortInfo.h.

◆ AddIpv6Cidrs() [3/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 718 of file InstancePortInfo.h.

◆ CidrListAliasesHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::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 735 of file InstancePortInfo.h.

◆ CidrsHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::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.

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

Definition at line 532 of file InstancePortInfo.h.

◆ CommonNameHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::CommonNameHasBeenSet ( ) const
inline

The common name of the port information.

Definition at line 436 of file InstancePortInfo.h.

◆ FromPortHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::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 77 of file InstancePortInfo.h.

◆ GetAccessDirection()

const AccessDirection& Aws::Lightsail::Model::InstancePortInfo::GetAccessDirection ( ) const
inline

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

Definition at line 474 of file InstancePortInfo.h.

◆ GetAccessFrom()

const Aws::String& Aws::Lightsail::Model::InstancePortInfo::GetAccessFrom ( ) const
inline

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.

Definition at line 345 of file InstancePortInfo.h.

◆ GetAccessType()

const PortAccessType& Aws::Lightsail::Model::InstancePortInfo::GetAccessType ( ) const
inline

The type of access (Public or Private).

Definition at line 400 of file InstancePortInfo.h.

◆ GetCidrListAliases()

const Aws::Vector<Aws::String>& Aws::Lightsail::Model::InstancePortInfo::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 727 of file InstancePortInfo.h.

◆ GetCidrs()

const Aws::Vector<Aws::String>& Aws::Lightsail::Model::InstancePortInfo::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.

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

Definition at line 521 of file InstancePortInfo.h.

◆ GetCommonName()

const Aws::String& Aws::Lightsail::Model::InstancePortInfo::GetCommonName ( ) const
inline

The common name of the port information.

Definition at line 431 of file InstancePortInfo.h.

◆ GetFromPort()

int Aws::Lightsail::Model::InstancePortInfo::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 60 of file InstancePortInfo.h.

◆ GetIpv6Cidrs()

const Aws::Vector<Aws::String>& Aws::Lightsail::Model::InstancePortInfo::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 622 of file InstancePortInfo.h.

◆ GetProtocol()

const NetworkProtocol& Aws::Lightsail::Model::InstancePortInfo::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 207 of file InstancePortInfo.h.

◆ GetToPort()

int Aws::Lightsail::Model::InstancePortInfo::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 129 of file InstancePortInfo.h.

◆ Ipv6CidrsHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::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 634 of file InstancePortInfo.h.

◆ Jsonize()

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

◆ operator=()

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

◆ ProtocolHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::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 233 of file InstancePortInfo.h.

◆ SetAccessDirection() [1/2]

void Aws::Lightsail::Model::InstancePortInfo::SetAccessDirection ( AccessDirection &&  value)
inline

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

Definition at line 495 of file InstancePortInfo.h.

◆ SetAccessDirection() [2/2]

void Aws::Lightsail::Model::InstancePortInfo::SetAccessDirection ( const AccessDirection value)
inline

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

Definition at line 488 of file InstancePortInfo.h.

◆ SetAccessFrom() [1/3]

void Aws::Lightsail::Model::InstancePortInfo::SetAccessFrom ( Aws::String &&  value)
inline

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.

Definition at line 366 of file InstancePortInfo.h.

◆ SetAccessFrom() [2/3]

void Aws::Lightsail::Model::InstancePortInfo::SetAccessFrom ( const Aws::String value)
inline

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.

Definition at line 359 of file InstancePortInfo.h.

◆ SetAccessFrom() [3/3]

void Aws::Lightsail::Model::InstancePortInfo::SetAccessFrom ( const char *  value)
inline

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.

Definition at line 373 of file InstancePortInfo.h.

◆ SetAccessType() [1/2]

void Aws::Lightsail::Model::InstancePortInfo::SetAccessType ( const PortAccessType value)
inline

The type of access (Public or Private).

Definition at line 410 of file InstancePortInfo.h.

◆ SetAccessType() [2/2]

void Aws::Lightsail::Model::InstancePortInfo::SetAccessType ( PortAccessType &&  value)
inline

The type of access (Public or Private).

Definition at line 415 of file InstancePortInfo.h.

◆ SetCidrListAliases() [1/2]

void Aws::Lightsail::Model::InstancePortInfo::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 751 of file InstancePortInfo.h.

◆ SetCidrListAliases() [2/2]

void Aws::Lightsail::Model::InstancePortInfo::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 743 of file InstancePortInfo.h.

◆ SetCidrs() [1/2]

void Aws::Lightsail::Model::InstancePortInfo::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.

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

Definition at line 554 of file InstancePortInfo.h.

◆ SetCidrs() [2/2]

void Aws::Lightsail::Model::InstancePortInfo::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.

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

Definition at line 543 of file InstancePortInfo.h.

◆ SetCommonName() [1/3]

void Aws::Lightsail::Model::InstancePortInfo::SetCommonName ( Aws::String &&  value)
inline

The common name of the port information.

Definition at line 446 of file InstancePortInfo.h.

◆ SetCommonName() [2/3]

void Aws::Lightsail::Model::InstancePortInfo::SetCommonName ( const Aws::String value)
inline

The common name of the port information.

Definition at line 441 of file InstancePortInfo.h.

◆ SetCommonName() [3/3]

void Aws::Lightsail::Model::InstancePortInfo::SetCommonName ( const char *  value)
inline

The common name of the port information.

Definition at line 451 of file InstancePortInfo.h.

◆ SetFromPort()

void Aws::Lightsail::Model::InstancePortInfo::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 94 of file InstancePortInfo.h.

◆ SetIpv6Cidrs() [1/2]

void Aws::Lightsail::Model::InstancePortInfo::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 658 of file InstancePortInfo.h.

◆ SetIpv6Cidrs() [2/2]

void Aws::Lightsail::Model::InstancePortInfo::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 646 of file InstancePortInfo.h.

◆ SetProtocol() [1/2]

void Aws::Lightsail::Model::InstancePortInfo::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 259 of file InstancePortInfo.h.

◆ SetProtocol() [2/2]

void Aws::Lightsail::Model::InstancePortInfo::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 285 of file InstancePortInfo.h.

◆ SetToPort()

void Aws::Lightsail::Model::InstancePortInfo::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 163 of file InstancePortInfo.h.

◆ ToPortHasBeenSet()

bool Aws::Lightsail::Model::InstancePortInfo::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 146 of file InstancePortInfo.h.

◆ WithAccessDirection() [1/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithAccessDirection ( AccessDirection &&  value)
inline

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

Definition at line 509 of file InstancePortInfo.h.

◆ WithAccessDirection() [2/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithAccessDirection ( const AccessDirection value)
inline

The access direction (inbound or outbound).

Lightsail currently supports only inbound access direction.

Definition at line 502 of file InstancePortInfo.h.

◆ WithAccessFrom() [1/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithAccessFrom ( Aws::String &&  value)
inline

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.

Definition at line 387 of file InstancePortInfo.h.

◆ WithAccessFrom() [2/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithAccessFrom ( const Aws::String value)
inline

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.

Definition at line 380 of file InstancePortInfo.h.

◆ WithAccessFrom() [3/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithAccessFrom ( const char *  value)
inline

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.

Definition at line 394 of file InstancePortInfo.h.

◆ WithAccessType() [1/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithAccessType ( const PortAccessType value)
inline

The type of access (Public or Private).

Definition at line 420 of file InstancePortInfo.h.

◆ WithAccessType() [2/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithAccessType ( PortAccessType &&  value)
inline

The type of access (Public or Private).

Definition at line 425 of file InstancePortInfo.h.

◆ WithCidrListAliases() [1/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 767 of file InstancePortInfo.h.

◆ WithCidrListAliases() [2/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 759 of file InstancePortInfo.h.

◆ WithCidrs() [1/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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.

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

Definition at line 576 of file InstancePortInfo.h.

◆ WithCidrs() [2/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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.

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

Definition at line 565 of file InstancePortInfo.h.

◆ WithCommonName() [1/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithCommonName ( Aws::String &&  value)
inline

The common name of the port information.

Definition at line 461 of file InstancePortInfo.h.

◆ WithCommonName() [2/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithCommonName ( const Aws::String value)
inline

The common name of the port information.

Definition at line 456 of file InstancePortInfo.h.

◆ WithCommonName() [3/3]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::WithCommonName ( const char *  value)
inline

The common name of the port information.

Definition at line 466 of file InstancePortInfo.h.

◆ WithFromPort()

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 111 of file InstancePortInfo.h.

◆ WithIpv6Cidrs() [1/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 682 of file InstancePortInfo.h.

◆ WithIpv6Cidrs() [2/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 670 of file InstancePortInfo.h.

◆ WithProtocol() [1/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 311 of file InstancePortInfo.h.

◆ WithProtocol() [2/2]

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 337 of file InstancePortInfo.h.

◆ WithToPort()

InstancePortInfo& Aws::Lightsail::Model::InstancePortInfo::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 180 of file InstancePortInfo.h.


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