/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include The load balancer configuration to use with a service or task set. When you add, update, or remove a load balancer configuration, Amazon ECS
* starts a new deployment with the updated Elastic Load Balancing configuration.
* This causes tasks to register to and deregister from load balancers. We
* recommend that you verify this on a test environment before you update the
* Elastic Load Balancing configuration. A service-linked role is required
* for services that use multiple target groups. For more information, see Using
* service-linked roles in the Amazon Elastic Container Service Developer
* Guide.See Also:
AWS
* API Reference
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're using a Classic Load Balancer, omit the target group * ARN.
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're 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, you must choose ip
as the
* target type, not instance
. Do this 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. This network mode is
* required for the Fargate launch type.
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're using a Classic Load Balancer, omit the target group * ARN.
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're 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, you must choose ip
as the
* target type, not instance
. Do this 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. This network mode is
* required for the Fargate launch type.
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're using a Classic Load Balancer, omit the target group * ARN.
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're 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, you must choose ip
as the
* target type, not instance
. Do this 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. This network mode is
* required for the Fargate launch type.
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're using a Classic Load Balancer, omit the target group * ARN.
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're 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, you must choose ip
as the
* target type, not instance
. Do this 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. This network mode is
* required for the Fargate launch type.
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're using a Classic Load Balancer, omit the target group * ARN.
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're 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, you must choose ip
as the
* target type, not instance
. Do this 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. This network mode is
* required for the Fargate launch type.
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're using a Classic Load Balancer, omit the target group * ARN.
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're 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, you must choose ip
as the
* target type, not instance
. Do this 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. This network mode is
* required for the Fargate launch type.
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're using a Classic Load Balancer, omit the target group * ARN.
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're 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, you must choose ip
as the
* target type, not instance
. Do this 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. This network mode is
* required for the Fargate launch type.
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're using a Classic Load Balancer, omit the target group * ARN.
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're 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, you must choose ip
as the
* target type, not instance
. Do this 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. This network mode is
* required for the Fargate launch type.
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.
*/ inline const Aws::String& GetLoadBalancerName() const{ return m_loadBalancerName; } /** *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.
*/ inline bool LoadBalancerNameHasBeenSet() const { return m_loadBalancerNameHasBeenSet; } /** *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.
*/ inline void SetLoadBalancerName(const Aws::String& value) { m_loadBalancerNameHasBeenSet = true; m_loadBalancerName = value; } /** *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.
*/ inline void SetLoadBalancerName(Aws::String&& value) { m_loadBalancerNameHasBeenSet = true; m_loadBalancerName = std::move(value); } /** *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.
*/ inline void SetLoadBalancerName(const char* value) { m_loadBalancerNameHasBeenSet = true; m_loadBalancerName.assign(value); } /** *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.
*/ inline LoadBalancer& WithLoadBalancerName(const Aws::String& value) { SetLoadBalancerName(value); return *this;} /** *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.
*/ inline LoadBalancer& WithLoadBalancerName(Aws::String&& value) { SetLoadBalancerName(std::move(value)); return *this;} /** *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.
*/ inline LoadBalancer& WithLoadBalancerName(const char* value) { SetLoadBalancerName(value); return *this;} /** *The name of the container (as it appears in a container definition) to * associate with the load balancer.
*/ inline const Aws::String& GetContainerName() const{ return m_containerName; } /** *The name of the container (as it appears in a container definition) to * associate with the load balancer.
*/ inline bool ContainerNameHasBeenSet() const { return m_containerNameHasBeenSet; } /** *The name of the container (as it appears in a container definition) to * associate with the load balancer.
*/ inline void SetContainerName(const Aws::String& value) { m_containerNameHasBeenSet = true; m_containerName = value; } /** *The name of the container (as it appears in a container definition) to * associate with the load balancer.
*/ inline void SetContainerName(Aws::String&& value) { m_containerNameHasBeenSet = true; m_containerName = std::move(value); } /** *The name of the container (as it appears in a container definition) to * associate with the load balancer.
*/ inline void SetContainerName(const char* value) { m_containerNameHasBeenSet = true; m_containerName.assign(value); } /** *The name of the container (as it appears in a container definition) to * associate with the load balancer.
*/ inline LoadBalancer& WithContainerName(const Aws::String& value) { SetContainerName(value); return *this;} /** *The name of the container (as it appears in a container definition) to * associate with the load balancer.
*/ inline LoadBalancer& WithContainerName(Aws::String&& value) { SetContainerName(std::move(value)); return *this;} /** *The name of the container (as it appears in a container definition) to * associate with the load balancer.
*/ inline LoadBalancer& WithContainerName(const char* value) { SetContainerName(value); return *this;} /** *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're launched on must allow ingress traffic on the
* hostPort
of the port mapping.
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're launched on must allow ingress traffic on the
* hostPort
of the port mapping.
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're launched on must allow ingress traffic on the
* hostPort
of the port mapping.
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're launched on must allow ingress traffic on the
* hostPort
of the port mapping.