You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticLoadBalancingV2::Types::TargetDescription

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb

Overview

Note:

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

{
  id: "TargetId", # required
  port: 1,
  availability_zone: "ZoneName",
}

Information about a target.

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zoneString

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 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 IP address is outside the VPC for the target group, the only supported value is all.

Returns:

  • (String)


2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2297

class TargetDescription < Struct.new(
  :id,
  :port,
  :availability_zone)
  include Aws::Structure
end

#idString

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.

Returns:

  • (String)


2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2297

class TargetDescription < Struct.new(
  :id,
  :port,
  :availability_zone)
  include Aws::Structure
end

#portInteger

The port on which the target is listening.

Returns:

  • (Integer)


2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 2297

class TargetDescription < Struct.new(
  :id,
  :port,
  :availability_zone)
  include Aws::Structure
end