AWS SDK for C++  1.8.79
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticLoadBalancingv2::Model::TargetDescription Class Reference

#include <TargetDescription.h>

Public Member Functions

 TargetDescription ()
 
 TargetDescription (const Aws::Utils::Xml::XmlNode &xmlNode)
 
TargetDescriptionoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
TargetDescriptionWithId (const Aws::String &value)
 
TargetDescriptionWithId (Aws::String &&value)
 
TargetDescriptionWithId (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
TargetDescriptionWithPort (int value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
TargetDescriptionWithAvailabilityZone (const Aws::String &value)
 
TargetDescriptionWithAvailabilityZone (Aws::String &&value)
 
TargetDescriptionWithAvailabilityZone (const char *value)
 

Detailed Description

Information about a target.

See Also:

AWS API Reference

Definition at line 31 of file TargetDescription.h.

Constructor & Destructor Documentation

◆ TargetDescription() [1/2]

Aws::ElasticLoadBalancingv2::Model::TargetDescription::TargetDescription ( )

◆ TargetDescription() [2/2]

Aws::ElasticLoadBalancingv2::Model::TargetDescription::TargetDescription ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AvailabilityZoneHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::TargetDescription::AvailabilityZoneHasBeenSet ( ) const
inline

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

Definition at line 162 of file TargetDescription.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::TargetDescription::GetAvailabilityZone ( ) const
inline

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

Definition at line 146 of file TargetDescription.h.

◆ GetId()

const Aws::String& Aws::ElasticLoadBalancingv2::Model::TargetDescription::GetId ( ) const
inline

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.

Definition at line 48 of file TargetDescription.h.

◆ GetPort()

int Aws::ElasticLoadBalancingv2::Model::TargetDescription::GetPort ( ) const
inline

The port on which the target is listening. Not used if the target is a Lambda function.

Definition at line 111 of file TargetDescription.h.

◆ IdHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::TargetDescription::IdHasBeenSet ( ) const
inline

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.

Definition at line 56 of file TargetDescription.h.

◆ operator=()

TargetDescription& Aws::ElasticLoadBalancingv2::Model::TargetDescription::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::ElasticLoadBalancingv2::Model::TargetDescription::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::ElasticLoadBalancingv2::Model::TargetDescription::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ PortHasBeenSet()

bool Aws::ElasticLoadBalancingv2::Model::TargetDescription::PortHasBeenSet ( ) const
inline

The port on which the target is listening. Not used if the target is a Lambda function.

Definition at line 117 of file TargetDescription.h.

◆ SetAvailabilityZone() [1/3]

void Aws::ElasticLoadBalancingv2::Model::TargetDescription::SetAvailabilityZone ( const Aws::String value)
inline

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

Definition at line 178 of file TargetDescription.h.

◆ SetAvailabilityZone() [2/3]

void Aws::ElasticLoadBalancingv2::Model::TargetDescription::SetAvailabilityZone ( Aws::String &&  value)
inline

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

Definition at line 194 of file TargetDescription.h.

◆ SetAvailabilityZone() [3/3]

void Aws::ElasticLoadBalancingv2::Model::TargetDescription::SetAvailabilityZone ( const char *  value)
inline

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

Definition at line 210 of file TargetDescription.h.

◆ SetId() [1/3]

void Aws::ElasticLoadBalancingv2::Model::TargetDescription::SetId ( const Aws::String value)
inline

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.

Definition at line 64 of file TargetDescription.h.

◆ SetId() [2/3]

void Aws::ElasticLoadBalancingv2::Model::TargetDescription::SetId ( Aws::String &&  value)
inline

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.

Definition at line 72 of file TargetDescription.h.

◆ SetId() [3/3]

void Aws::ElasticLoadBalancingv2::Model::TargetDescription::SetId ( const char *  value)
inline

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.

Definition at line 80 of file TargetDescription.h.

◆ SetPort()

void Aws::ElasticLoadBalancingv2::Model::TargetDescription::SetPort ( int  value)
inline

The port on which the target is listening. Not used if the target is a Lambda function.

Definition at line 123 of file TargetDescription.h.

◆ WithAvailabilityZone() [1/3]

TargetDescription& Aws::ElasticLoadBalancingv2::Model::TargetDescription::WithAvailabilityZone ( const Aws::String value)
inline

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

Definition at line 226 of file TargetDescription.h.

◆ WithAvailabilityZone() [2/3]

TargetDescription& Aws::ElasticLoadBalancingv2::Model::TargetDescription::WithAvailabilityZone ( Aws::String &&  value)
inline

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

Definition at line 242 of file TargetDescription.h.

◆ WithAvailabilityZone() [3/3]

TargetDescription& Aws::ElasticLoadBalancingv2::Model::TargetDescription::WithAvailabilityZone ( const char *  value)
inline

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

Definition at line 258 of file TargetDescription.h.

◆ WithId() [1/3]

TargetDescription& Aws::ElasticLoadBalancingv2::Model::TargetDescription::WithId ( const Aws::String value)
inline

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.

Definition at line 88 of file TargetDescription.h.

◆ WithId() [2/3]

TargetDescription& Aws::ElasticLoadBalancingv2::Model::TargetDescription::WithId ( Aws::String &&  value)
inline

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.

Definition at line 96 of file TargetDescription.h.

◆ WithId() [3/3]

TargetDescription& Aws::ElasticLoadBalancingv2::Model::TargetDescription::WithId ( const char *  value)
inline

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.

Definition at line 104 of file TargetDescription.h.

◆ WithPort()

TargetDescription& Aws::ElasticLoadBalancingv2::Model::TargetDescription::WithPort ( int  value)
inline

The port on which the target is listening. Not used if the target is a Lambda function.

Definition at line 129 of file TargetDescription.h.


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