Amazonka.ELBV2.Types.TargetDescription

Documentation

data TargetDescription

Information about a target.

See: newTargetDescription smart constructor.

Constructors

TargetDescription'

Fields

• availabilityZone :: Maybe Text

  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.

  For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all.

  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.

  For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.

  If the target type is lambda, this parameter is optional and the only supported value is all.

• port :: Maybe Natural

  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.

• id :: Text

  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.

Instances

ToQuery TargetDescription

Defined in Amazonka.ELBV2.Types.TargetDescription

Methods

toQuery :: TargetDescription -> QueryString

FromXML TargetDescription

Defined in Amazonka.ELBV2.Types.TargetDescription

Methods

parseXML :: [Node] -> Either String TargetDescription

Generic TargetDescription

Defined in Amazonka.ELBV2.Types.TargetDescription

Associated Types

type Rep TargetDescription :: Type -> Type

Methods

from :: TargetDescription -> Rep TargetDescription x

to :: Rep TargetDescription x -> TargetDescription

Read TargetDescription

Defined in Amazonka.ELBV2.Types.TargetDescription

Methods

readsPrec :: Int -> ReadS TargetDescription

readList :: ReadS [TargetDescription]

readPrec :: ReadPrec TargetDescription

readListPrec :: ReadPrec [TargetDescription]

Show TargetDescription

Defined in Amazonka.ELBV2.Types.TargetDescription

Methods

showsPrec :: Int -> TargetDescription -> ShowS

show :: TargetDescription -> String

showList :: [TargetDescription] -> ShowS

NFData TargetDescription

Defined in Amazonka.ELBV2.Types.TargetDescription

Methods

rnf :: TargetDescription -> ()

Eq TargetDescription

Defined in Amazonka.ELBV2.Types.TargetDescription

Methods

(==) :: TargetDescription -> TargetDescription -> Bool

(/=) :: TargetDescription -> TargetDescription -> Bool

Hashable TargetDescription

Defined in Amazonka.ELBV2.Types.TargetDescription

Methods

hashWithSalt :: Int -> TargetDescription -> Int

hash :: TargetDescription -> Int

type Rep TargetDescription

Defined in Amazonka.ELBV2.Types.TargetDescription

type Rep TargetDescription = D1 ('MetaData "TargetDescription" "Amazonka.ELBV2.Types.TargetDescription" "amazonka-elbv2-2.0-361J9F5fkBoAtGaOoJg8Ev" 'False) (C1 ('MetaCons "TargetDescription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newTargetDescription

Arguments

:: Text

$sel:id:TargetDescription'

-> TargetDescription

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.

For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all.

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.

For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.

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)

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.

For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all.

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.

For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.

If the target type is lambda, this parameter is optional and the only supported value is all.

targetDescription_port :: Lens' TargetDescription (Maybe Natural)

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

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.