AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::LoadBalancer Class Reference

#include <LoadBalancer.h>

Public Member Functions

 LoadBalancer ()
 
 LoadBalancer (Aws::Utils::Json::JsonView jsonValue)
 
LoadBalanceroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetTargetGroupArn () const
 
bool TargetGroupArnHasBeenSet () const
 
void SetTargetGroupArn (const Aws::String &value)
 
void SetTargetGroupArn (Aws::String &&value)
 
void SetTargetGroupArn (const char *value)
 
LoadBalancerWithTargetGroupArn (const Aws::String &value)
 
LoadBalancerWithTargetGroupArn (Aws::String &&value)
 
LoadBalancerWithTargetGroupArn (const char *value)
 
const Aws::StringGetLoadBalancerName () const
 
bool LoadBalancerNameHasBeenSet () const
 
void SetLoadBalancerName (const Aws::String &value)
 
void SetLoadBalancerName (Aws::String &&value)
 
void SetLoadBalancerName (const char *value)
 
LoadBalancerWithLoadBalancerName (const Aws::String &value)
 
LoadBalancerWithLoadBalancerName (Aws::String &&value)
 
LoadBalancerWithLoadBalancerName (const char *value)
 
const Aws::StringGetContainerName () const
 
bool ContainerNameHasBeenSet () const
 
void SetContainerName (const Aws::String &value)
 
void SetContainerName (Aws::String &&value)
 
void SetContainerName (const char *value)
 
LoadBalancerWithContainerName (const Aws::String &value)
 
LoadBalancerWithContainerName (Aws::String &&value)
 
LoadBalancerWithContainerName (const char *value)
 
int GetContainerPort () const
 
bool ContainerPortHasBeenSet () const
 
void SetContainerPort (int value)
 
LoadBalancerWithContainerPort (int value)
 

Detailed Description

The load balancer configuration to use with a service or task set.

For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.

See Also:

AWS API Reference

Definition at line 34 of file LoadBalancer.h.

Constructor & Destructor Documentation

◆ LoadBalancer() [1/2]

Aws::ECS::Model::LoadBalancer::LoadBalancer ( )

◆ LoadBalancer() [2/2]

Aws::ECS::Model::LoadBalancer::LoadBalancer ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ContainerNameHasBeenSet()

bool Aws::ECS::Model::LoadBalancer::ContainerNameHasBeenSet ( ) const
inline

The name of the container (as it appears in a container definition) to associate with the load balancer.

Definition at line 311 of file LoadBalancer.h.

◆ ContainerPortHasBeenSet()

bool Aws::ECS::Model::LoadBalancer::ContainerPortHasBeenSet ( ) const
inline

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.

Definition at line 366 of file LoadBalancer.h.

◆ GetContainerName()

const Aws::String& Aws::ECS::Model::LoadBalancer::GetContainerName ( ) const
inline

The name of the container (as it appears in a container definition) to associate with the load balancer.

Definition at line 305 of file LoadBalancer.h.

◆ GetContainerPort()

int Aws::ECS::Model::LoadBalancer::GetContainerPort ( ) const
inline

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.

Definition at line 357 of file LoadBalancer.h.

◆ GetLoadBalancerName()

const Aws::String& Aws::ECS::Model::LoadBalancer::GetLoadBalancerName ( ) const
inline

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

Definition at line 242 of file LoadBalancer.h.

◆ GetTargetGroupArn()

const Aws::String& Aws::ECS::Model::LoadBalancer::GetTargetGroupArn ( ) const
inline

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 65 of file LoadBalancer.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::LoadBalancer::Jsonize ( ) const

◆ LoadBalancerNameHasBeenSet()

bool Aws::ECS::Model::LoadBalancer::LoadBalancerNameHasBeenSet ( ) const
inline

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

Definition at line 250 of file LoadBalancer.h.

◆ operator=()

LoadBalancer& Aws::ECS::Model::LoadBalancer::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetContainerName() [1/3]

void Aws::ECS::Model::LoadBalancer::SetContainerName ( const Aws::String value)
inline

The name of the container (as it appears in a container definition) to associate with the load balancer.

Definition at line 317 of file LoadBalancer.h.

◆ SetContainerName() [2/3]

void Aws::ECS::Model::LoadBalancer::SetContainerName ( Aws::String &&  value)
inline

The name of the container (as it appears in a container definition) to associate with the load balancer.

Definition at line 323 of file LoadBalancer.h.

◆ SetContainerName() [3/3]

void Aws::ECS::Model::LoadBalancer::SetContainerName ( const char *  value)
inline

The name of the container (as it appears in a container definition) to associate with the load balancer.

Definition at line 329 of file LoadBalancer.h.

◆ SetContainerPort()

void Aws::ECS::Model::LoadBalancer::SetContainerPort ( int  value)
inline

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.

Definition at line 375 of file LoadBalancer.h.

◆ SetLoadBalancerName() [1/3]

void Aws::ECS::Model::LoadBalancer::SetLoadBalancerName ( const Aws::String value)
inline

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

Definition at line 258 of file LoadBalancer.h.

◆ SetLoadBalancerName() [2/3]

void Aws::ECS::Model::LoadBalancer::SetLoadBalancerName ( Aws::String &&  value)
inline

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

Definition at line 266 of file LoadBalancer.h.

◆ SetLoadBalancerName() [3/3]

void Aws::ECS::Model::LoadBalancer::SetLoadBalancerName ( const char *  value)
inline

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

Definition at line 274 of file LoadBalancer.h.

◆ SetTargetGroupArn() [1/3]

void Aws::ECS::Model::LoadBalancer::SetTargetGroupArn ( const Aws::String value)
inline

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 113 of file LoadBalancer.h.

◆ SetTargetGroupArn() [2/3]

void Aws::ECS::Model::LoadBalancer::SetTargetGroupArn ( Aws::String &&  value)
inline

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 137 of file LoadBalancer.h.

◆ SetTargetGroupArn() [3/3]

void Aws::ECS::Model::LoadBalancer::SetTargetGroupArn ( const char *  value)
inline

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 161 of file LoadBalancer.h.

◆ TargetGroupArnHasBeenSet()

bool Aws::ECS::Model::LoadBalancer::TargetGroupArnHasBeenSet ( ) const
inline

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 89 of file LoadBalancer.h.

◆ WithContainerName() [1/3]

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithContainerName ( const Aws::String value)
inline

The name of the container (as it appears in a container definition) to associate with the load balancer.

Definition at line 335 of file LoadBalancer.h.

◆ WithContainerName() [2/3]

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithContainerName ( Aws::String &&  value)
inline

The name of the container (as it appears in a container definition) to associate with the load balancer.

Definition at line 341 of file LoadBalancer.h.

◆ WithContainerName() [3/3]

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithContainerName ( const char *  value)
inline

The name of the container (as it appears in a container definition) to associate with the load balancer.

Definition at line 347 of file LoadBalancer.h.

◆ WithContainerPort()

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithContainerPort ( int  value)
inline

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.

Definition at line 384 of file LoadBalancer.h.

◆ WithLoadBalancerName() [1/3]

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithLoadBalancerName ( const Aws::String value)
inline

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

Definition at line 282 of file LoadBalancer.h.

◆ WithLoadBalancerName() [2/3]

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithLoadBalancerName ( Aws::String &&  value)
inline

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

Definition at line 290 of file LoadBalancer.h.

◆ WithLoadBalancerName() [3/3]

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithLoadBalancerName ( const char *  value)
inline

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.

Definition at line 298 of file LoadBalancer.h.

◆ WithTargetGroupArn() [1/3]

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithTargetGroupArn ( const Aws::String value)
inline

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 185 of file LoadBalancer.h.

◆ WithTargetGroupArn() [2/3]

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithTargetGroupArn ( Aws::String &&  value)
inline

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 209 of file LoadBalancer.h.

◆ WithTargetGroupArn() [3/3]

LoadBalancer& Aws::ECS::Model::LoadBalancer::WithTargetGroupArn ( const char *  value)
inline

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Definition at line 233 of file LoadBalancer.h.


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