AWS SDK for C++  1.8.96
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 > & 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 441 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 312 of file InstancePortInfo.h.

◆ AccessTypeHasBeenSet()

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

The type of access (Public or Private).

Definition at line 365 of file InstancePortInfo.h.

◆ AddCidrListAliases() [1/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 617 of file InstancePortInfo.h.

◆ AddCidrListAliases() [2/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 625 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 633 of file InstancePortInfo.h.

◆ AddCidrs() [1/3]

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

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.

Definition at line 540 of file InstancePortInfo.h.

◆ AddCidrs() [2/3]

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

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.

Definition at line 550 of file InstancePortInfo.h.

◆ AddCidrs() [3/3]

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

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.

Definition at line 560 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 577 of file InstancePortInfo.h.

◆ CidrsHasBeenSet()

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

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.

Definition at line 490 of file InstancePortInfo.h.

◆ CommonNameHasBeenSet()

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

The common name of the port information.

Definition at line 396 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 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.

Definition at line 67 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 434 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 305 of file InstancePortInfo.h.

◆ GetAccessType()

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

The type of access (Public or Private).

Definition at line 360 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 569 of file InstancePortInfo.h.

◆ GetCidrs()

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

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.

Definition at line 480 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 391 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 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.

Definition at line 55 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 167 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 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.

Definition at line 104 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 193 of file InstancePortInfo.h.

◆ SetAccessDirection() [1/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 448 of file InstancePortInfo.h.

◆ SetAccessDirection() [2/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 455 of file InstancePortInfo.h.

◆ SetAccessFrom() [1/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 319 of file InstancePortInfo.h.

◆ SetAccessFrom() [2/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 326 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 333 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 370 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 375 of file InstancePortInfo.h.

◆ SetCidrListAliases() [1/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 585 of file InstancePortInfo.h.

◆ SetCidrListAliases() [2/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 593 of file InstancePortInfo.h.

◆ SetCidrs() [1/2]

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

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.

Definition at line 500 of file InstancePortInfo.h.

◆ SetCidrs() [2/2]

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

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.

Definition at line 510 of file InstancePortInfo.h.

◆ SetCommonName() [1/3]

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

The common name of the port information.

Definition at line 401 of file InstancePortInfo.h.

◆ SetCommonName() [2/3]

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

The common name of the port information.

Definition at line 406 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 411 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 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.

Definition at line 79 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 219 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 245 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 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.

Definition at line 128 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 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.

Definition at line 116 of file InstancePortInfo.h.

◆ WithAccessDirection() [1/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 462 of file InstancePortInfo.h.

◆ WithAccessDirection() [2/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 469 of file InstancePortInfo.h.

◆ WithAccessFrom() [1/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 340 of file InstancePortInfo.h.

◆ WithAccessFrom() [2/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 347 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 354 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 380 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 385 of file InstancePortInfo.h.

◆ WithCidrListAliases() [1/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 601 of file InstancePortInfo.h.

◆ WithCidrListAliases() [2/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 609 of file InstancePortInfo.h.

◆ WithCidrs() [1/2]

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

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.

Definition at line 520 of file InstancePortInfo.h.

◆ WithCidrs() [2/2]

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

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.

Definition at line 530 of file InstancePortInfo.h.

◆ WithCommonName() [1/3]

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

The common name of the port information.

Definition at line 416 of file InstancePortInfo.h.

◆ WithCommonName() [2/3]

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

The common name of the port information.

Definition at line 421 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 426 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 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.

Definition at line 91 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 271 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 297 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 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.

Definition at line 140 of file InstancePortInfo.h.


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