Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Documentation
data TargetDescription Source #
Information about a target.
See: newTargetDescription
smart constructor.
TargetDescription' | |
|
Instances
Create a value of TargetDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityZone:TargetDescription'
, targetDescription_availabilityZone
- 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
.
$sel:port:TargetDescription'
, targetDescription_port
- 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.
$sel:id:TargetDescription'
, targetDescription_id
- 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.
targetDescription_availabilityZone :: Lens' TargetDescription (Maybe Text) Source #
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
.
targetDescription_port :: Lens' TargetDescription (Maybe Natural) Source #
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.
targetDescription_id :: Lens' TargetDescription Text Source #
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.