Class: Aws::ECS::Types::LoadBalancer

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass LoadBalancer data as a hash:

{
  target_group_arn: "String",
  load_balancer_name: "String",
  container_name: "String",
  container_port: 1,
}

Details on a load balancer that is used with a service.

Services with tasks that use the ‘awsvpc` network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose `ip` as the target type, not `instance`, because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#container_name ⇒ String

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

Returns:

  • (String) 


3306
3307
3308
3309
3310
3311
3312
 
# File 'lib/aws-sdk-ecs/types.rb', line 3306

class LoadBalancer < Struct.new(
  :target_group_arn,
  :load_balancer_name,
  :container_name,
  :container_port)
  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 service’s task definition. Your container instances must allow ingress traffic on the ‘hostPort` of the port mapping.

Returns:

  • (Integer) 


3306
3307
3308
3309
3310
3311
3312
 
# File 'lib/aws-sdk-ecs/types.rb', line 3306

class LoadBalancer < Struct.new(
  :target_group_arn,
  :load_balancer_name,
  :container_name,
  :container_port)
  include Aws::Structure
end

#load_balancer_name ⇒ String

The name of a load balancer.

Returns:

  • (String) 


3306
3307
3308
3309
3310
3311
3312
 
# File 'lib/aws-sdk-ecs/types.rb', line 3306

class LoadBalancer < Struct.new(
  :target_group_arn,
  :load_balancer_name,
  :container_name,
  :container_port)
  include Aws::Structure
end

#target_group_arn ⇒ String

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

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`, because tasks that use the `awsvpc` network mode are associated with an elastic network interface, not an Amazon EC2 instance.

Returns:

  • (String) 


3306
3307
3308
3309
3310
3311
3312
 
# File 'lib/aws-sdk-ecs/types.rb', line 3306

class LoadBalancer < Struct.new(
  :target_group_arn,
  :load_balancer_name,
  :container_name,
  :container_port)
  include Aws::Structure
end