Class: Aws::ElasticLoadBalancingV2::Types::TargetDescription
- Inherits:
-
Struct
- Object
- Struct
- Aws::ElasticLoadBalancingV2::Types::TargetDescription
- Defined in:
- gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#availability_zone ⇒ String
An Availability Zone or
all
. -
#id ⇒ String
The ID of the target.
-
#port ⇒ Integer
The port on which the target is listening.
Instance Attribute Details
#availability_zone ⇒ String
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
or alb
.
If the target type is ip
and 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 target type is ip
and
the IP address is outside the VPC for the target group, the only
supported value is all
.
If the target type is lambda
, this parameter is optional and the
only supported value is all
.
3982 3983 3984 3985 3986 3987 3988 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3982 class TargetDescription < Struct.new( :id, :port, :availability_zone) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
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. If the target type is lambda
, specify the
ARN of the Lambda function. If the target type is alb
, specify the
ARN of the Application Load Balancer target.
3982 3983 3984 3985 3986 3987 3988 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3982 class TargetDescription < Struct.new( :id, :port, :availability_zone) SENSITIVE = [] include Aws::Structure end |
#port ⇒ Integer
The port on which the target is listening. If the target group
protocol is GENEVE, the supported port is 6081. If the target type
is alb
, the targeted Application Load Balancer must have at least
one listener whose port matches the target group port. Not used if
the target is a Lambda function.
3982 3983 3984 3985 3986 3987 3988 |
# File 'gems/aws-sdk-elasticloadbalancingv2/lib/aws-sdk-elasticloadbalancingv2/types.rb', line 3982 class TargetDescription < Struct.new( :id, :port, :availability_zone) SENSITIVE = [] include Aws::Structure end |