{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.ELBV2.Types.TargetDescription
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.ELBV2.Types.TargetDescription where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | Information about a target.
--
-- /See:/ 'newTargetDescription' smart constructor.
data TargetDescription = TargetDescription'
  { -- | 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 -> Maybe Text
availabilityZone :: Prelude.Maybe Prelude.Text,
    -- | 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 -> Maybe Natural
port :: Prelude.Maybe Prelude.Natural,
    -- | 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 -> Text
id :: Prelude.Text
  }
  deriving (TargetDescription -> TargetDescription -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TargetDescription -> TargetDescription -> Bool
$c/= :: TargetDescription -> TargetDescription -> Bool
== :: TargetDescription -> TargetDescription -> Bool
$c== :: TargetDescription -> TargetDescription -> Bool
Prelude.Eq, ReadPrec [TargetDescription]
ReadPrec TargetDescription
Int -> ReadS TargetDescription
ReadS [TargetDescription]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TargetDescription]
$creadListPrec :: ReadPrec [TargetDescription]
readPrec :: ReadPrec TargetDescription
$creadPrec :: ReadPrec TargetDescription
readList :: ReadS [TargetDescription]
$creadList :: ReadS [TargetDescription]
readsPrec :: Int -> ReadS TargetDescription
$creadsPrec :: Int -> ReadS TargetDescription
Prelude.Read, Int -> TargetDescription -> ShowS
[TargetDescription] -> ShowS
TargetDescription -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TargetDescription] -> ShowS
$cshowList :: [TargetDescription] -> ShowS
show :: TargetDescription -> String
$cshow :: TargetDescription -> String
showsPrec :: Int -> TargetDescription -> ShowS
$cshowsPrec :: Int -> TargetDescription -> ShowS
Prelude.Show, forall x. Rep TargetDescription x -> TargetDescription
forall x. TargetDescription -> Rep TargetDescription x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TargetDescription x -> TargetDescription
$cfrom :: forall x. TargetDescription -> Rep TargetDescription x
Prelude.Generic)

-- |
-- Create a value of 'TargetDescription' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'availabilityZone', '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@.
--
-- 'port', '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.
--
-- 'id', '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.
newTargetDescription ::
  -- | 'id'
  Prelude.Text ->
  TargetDescription
newTargetDescription :: Text -> TargetDescription
newTargetDescription Text
pId_ =
  TargetDescription'
    { $sel:availabilityZone:TargetDescription' :: Maybe Text
availabilityZone =
        forall a. Maybe a
Prelude.Nothing,
      $sel:port:TargetDescription' :: Maybe Natural
port = forall a. Maybe a
Prelude.Nothing,
      $sel:id:TargetDescription' :: Text
id = Text
pId_
    }

-- | 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_availabilityZone :: Lens.Lens' TargetDescription (Prelude.Maybe Prelude.Text)
targetDescription_availabilityZone :: Lens' TargetDescription (Maybe Text)
targetDescription_availabilityZone = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TargetDescription' {Maybe Text
availabilityZone :: Maybe Text
$sel:availabilityZone:TargetDescription' :: TargetDescription -> Maybe Text
availabilityZone} -> Maybe Text
availabilityZone) (\s :: TargetDescription
s@TargetDescription' {} Maybe Text
a -> TargetDescription
s {$sel:availabilityZone:TargetDescription' :: Maybe Text
availabilityZone = Maybe Text
a} :: TargetDescription)

-- | 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_port :: Lens.Lens' TargetDescription (Prelude.Maybe Prelude.Natural)
targetDescription_port :: Lens' TargetDescription (Maybe Natural)
targetDescription_port = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TargetDescription' {Maybe Natural
port :: Maybe Natural
$sel:port:TargetDescription' :: TargetDescription -> Maybe Natural
port} -> Maybe Natural
port) (\s :: TargetDescription
s@TargetDescription' {} Maybe Natural
a -> TargetDescription
s {$sel:port:TargetDescription' :: Maybe Natural
port = Maybe Natural
a} :: TargetDescription)

-- | 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_id :: Lens.Lens' TargetDescription Prelude.Text
targetDescription_id :: Lens' TargetDescription Text
targetDescription_id = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TargetDescription' {Text
id :: Text
$sel:id:TargetDescription' :: TargetDescription -> Text
id} -> Text
id) (\s :: TargetDescription
s@TargetDescription' {} Text
a -> TargetDescription
s {$sel:id:TargetDescription' :: Text
id = Text
a} :: TargetDescription)

instance Data.FromXML TargetDescription where
  parseXML :: [Node] -> Either String TargetDescription
parseXML [Node]
x =
    Maybe Text -> Maybe Natural -> Text -> TargetDescription
TargetDescription'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"AvailabilityZone")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Port")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"Id")

instance Prelude.Hashable TargetDescription where
  hashWithSalt :: Int -> TargetDescription -> Int
hashWithSalt Int
_salt TargetDescription' {Maybe Natural
Maybe Text
Text
id :: Text
port :: Maybe Natural
availabilityZone :: Maybe Text
$sel:id:TargetDescription' :: TargetDescription -> Text
$sel:port:TargetDescription' :: TargetDescription -> Maybe Natural
$sel:availabilityZone:TargetDescription' :: TargetDescription -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
availabilityZone
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
port
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
id

instance Prelude.NFData TargetDescription where
  rnf :: TargetDescription -> ()
rnf TargetDescription' {Maybe Natural
Maybe Text
Text
id :: Text
port :: Maybe Natural
availabilityZone :: Maybe Text
$sel:id:TargetDescription' :: TargetDescription -> Text
$sel:port:TargetDescription' :: TargetDescription -> Maybe Natural
$sel:availabilityZone:TargetDescription' :: TargetDescription -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
availabilityZone
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
port
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
id

instance Data.ToQuery TargetDescription where
  toQuery :: TargetDescription -> QueryString
toQuery TargetDescription' {Maybe Natural
Maybe Text
Text
id :: Text
port :: Maybe Natural
availabilityZone :: Maybe Text
$sel:id:TargetDescription' :: TargetDescription -> Text
$sel:port:TargetDescription' :: TargetDescription -> Maybe Natural
$sel:availabilityZone:TargetDescription' :: TargetDescription -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"AvailabilityZone" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
availabilityZone,
        ByteString
"Port" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
port,
        ByteString
"Id" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
id
      ]