Class: Aws::ECS::Types::LoadBalancer
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::LoadBalancer
- Defined in:
- gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#container_name ⇒ String
The name of the container (as it appears in a container definition) to associate with the load balancer.
-
#container_port ⇒ Integer
The port on the container to associate with the load balancer.
-
#load_balancer_name ⇒ String
The name of the load balancer to associate with the Amazon ECS service or task set.
-
#target_group_arn ⇒ String
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
Instance Attribute Details
#container_name ⇒ String
The name of the container (as it appears in a container definition) to associate with the load balancer.
You need to specify the container name when configuring the target group for an Amazon ECS load balancer.
6445 6446 6447 6448 6449 6450 6451 6452 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6445 class LoadBalancer < Struct.new( :target_group_arn, :load_balancer_name, :container_name, :container_port) SENSITIVE = [] include Aws::Structure end |
#container_port ⇒ Integer
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.
6445 6446 6447 6448 6449 6450 6451 6452 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6445 class LoadBalancer < Struct.new( :target_group_arn, :load_balancer_name, :container_name, :container_port) SENSITIVE = [] include Aws::Structure end |
#load_balancer_name ⇒ String
The name of the load balancer to associate with the Amazon ECS service or task set.
If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
6445 6446 6447 6448 6449 6450 6451 6452 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6445 class LoadBalancer < Struct.new( :target_group_arn, :load_balancer_name, :container_name, :container_port) SENSITIVE = [] include Aws::Structure end |
#target_group_arn ⇒ String
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.
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.
6445 6446 6447 6448 6449 6450 6451 6452 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6445 class LoadBalancer < Struct.new( :target_group_arn, :load_balancer_name, :container_name, :container_port) SENSITIVE = [] include Aws::Structure end |