{-# 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.AppFlow.Types.AuthParameter
-- 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.AppFlow.Types.AuthParameter 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 required authentication parameters.
--
-- /See:/ 'newAuthParameter' smart constructor.
data AuthParameter = AuthParameter'
  { -- | Contains default values for this authentication parameter that are
    -- supplied by the connector.
    AuthParameter -> Maybe [Text]
connectorSuppliedValues :: Prelude.Maybe [Prelude.Text],
    -- | A description about the authentication parameter.
    AuthParameter -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | Indicates whether this authentication parameter is required.
    AuthParameter -> Maybe Bool
isRequired :: Prelude.Maybe Prelude.Bool,
    -- | Indicates whether this authentication parameter is a sensitive field.
    AuthParameter -> Maybe Bool
isSensitiveField :: Prelude.Maybe Prelude.Bool,
    -- | The authentication key required to authenticate with the connector.
    AuthParameter -> Maybe Text
key :: Prelude.Maybe Prelude.Text,
    -- | Label used for authentication parameter.
    AuthParameter -> Maybe Text
label :: Prelude.Maybe Prelude.Text
  }
  deriving (AuthParameter -> AuthParameter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AuthParameter -> AuthParameter -> Bool
$c/= :: AuthParameter -> AuthParameter -> Bool
== :: AuthParameter -> AuthParameter -> Bool
$c== :: AuthParameter -> AuthParameter -> Bool
Prelude.Eq, ReadPrec [AuthParameter]
ReadPrec AuthParameter
Int -> ReadS AuthParameter
ReadS [AuthParameter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AuthParameter]
$creadListPrec :: ReadPrec [AuthParameter]
readPrec :: ReadPrec AuthParameter
$creadPrec :: ReadPrec AuthParameter
readList :: ReadS [AuthParameter]
$creadList :: ReadS [AuthParameter]
readsPrec :: Int -> ReadS AuthParameter
$creadsPrec :: Int -> ReadS AuthParameter
Prelude.Read, Int -> AuthParameter -> ShowS
[AuthParameter] -> ShowS
AuthParameter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AuthParameter] -> ShowS
$cshowList :: [AuthParameter] -> ShowS
show :: AuthParameter -> String
$cshow :: AuthParameter -> String
showsPrec :: Int -> AuthParameter -> ShowS
$cshowsPrec :: Int -> AuthParameter -> ShowS
Prelude.Show, forall x. Rep AuthParameter x -> AuthParameter
forall x. AuthParameter -> Rep AuthParameter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AuthParameter x -> AuthParameter
$cfrom :: forall x. AuthParameter -> Rep AuthParameter x
Prelude.Generic)

-- |
-- Create a value of 'AuthParameter' 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:
--
-- 'connectorSuppliedValues', 'authParameter_connectorSuppliedValues' - Contains default values for this authentication parameter that are
-- supplied by the connector.
--
-- 'description', 'authParameter_description' - A description about the authentication parameter.
--
-- 'isRequired', 'authParameter_isRequired' - Indicates whether this authentication parameter is required.
--
-- 'isSensitiveField', 'authParameter_isSensitiveField' - Indicates whether this authentication parameter is a sensitive field.
--
-- 'key', 'authParameter_key' - The authentication key required to authenticate with the connector.
--
-- 'label', 'authParameter_label' - Label used for authentication parameter.
newAuthParameter ::
  AuthParameter
newAuthParameter :: AuthParameter
newAuthParameter =
  AuthParameter'
    { $sel:connectorSuppliedValues:AuthParameter' :: Maybe [Text]
connectorSuppliedValues =
        forall a. Maybe a
Prelude.Nothing,
      $sel:description:AuthParameter' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:isRequired:AuthParameter' :: Maybe Bool
isRequired = forall a. Maybe a
Prelude.Nothing,
      $sel:isSensitiveField:AuthParameter' :: Maybe Bool
isSensitiveField = forall a. Maybe a
Prelude.Nothing,
      $sel:key:AuthParameter' :: Maybe Text
key = forall a. Maybe a
Prelude.Nothing,
      $sel:label:AuthParameter' :: Maybe Text
label = forall a. Maybe a
Prelude.Nothing
    }

-- | Contains default values for this authentication parameter that are
-- supplied by the connector.
authParameter_connectorSuppliedValues :: Lens.Lens' AuthParameter (Prelude.Maybe [Prelude.Text])
authParameter_connectorSuppliedValues :: Lens' AuthParameter (Maybe [Text])
authParameter_connectorSuppliedValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AuthParameter' {Maybe [Text]
connectorSuppliedValues :: Maybe [Text]
$sel:connectorSuppliedValues:AuthParameter' :: AuthParameter -> Maybe [Text]
connectorSuppliedValues} -> Maybe [Text]
connectorSuppliedValues) (\s :: AuthParameter
s@AuthParameter' {} Maybe [Text]
a -> AuthParameter
s {$sel:connectorSuppliedValues:AuthParameter' :: Maybe [Text]
connectorSuppliedValues = Maybe [Text]
a} :: AuthParameter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A description about the authentication parameter.
authParameter_description :: Lens.Lens' AuthParameter (Prelude.Maybe Prelude.Text)
authParameter_description :: Lens' AuthParameter (Maybe Text)
authParameter_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AuthParameter' {Maybe Text
description :: Maybe Text
$sel:description:AuthParameter' :: AuthParameter -> Maybe Text
description} -> Maybe Text
description) (\s :: AuthParameter
s@AuthParameter' {} Maybe Text
a -> AuthParameter
s {$sel:description:AuthParameter' :: Maybe Text
description = Maybe Text
a} :: AuthParameter)

-- | Indicates whether this authentication parameter is required.
authParameter_isRequired :: Lens.Lens' AuthParameter (Prelude.Maybe Prelude.Bool)
authParameter_isRequired :: Lens' AuthParameter (Maybe Bool)
authParameter_isRequired = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AuthParameter' {Maybe Bool
isRequired :: Maybe Bool
$sel:isRequired:AuthParameter' :: AuthParameter -> Maybe Bool
isRequired} -> Maybe Bool
isRequired) (\s :: AuthParameter
s@AuthParameter' {} Maybe Bool
a -> AuthParameter
s {$sel:isRequired:AuthParameter' :: Maybe Bool
isRequired = Maybe Bool
a} :: AuthParameter)

-- | Indicates whether this authentication parameter is a sensitive field.
authParameter_isSensitiveField :: Lens.Lens' AuthParameter (Prelude.Maybe Prelude.Bool)
authParameter_isSensitiveField :: Lens' AuthParameter (Maybe Bool)
authParameter_isSensitiveField = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AuthParameter' {Maybe Bool
isSensitiveField :: Maybe Bool
$sel:isSensitiveField:AuthParameter' :: AuthParameter -> Maybe Bool
isSensitiveField} -> Maybe Bool
isSensitiveField) (\s :: AuthParameter
s@AuthParameter' {} Maybe Bool
a -> AuthParameter
s {$sel:isSensitiveField:AuthParameter' :: Maybe Bool
isSensitiveField = Maybe Bool
a} :: AuthParameter)

-- | The authentication key required to authenticate with the connector.
authParameter_key :: Lens.Lens' AuthParameter (Prelude.Maybe Prelude.Text)
authParameter_key :: Lens' AuthParameter (Maybe Text)
authParameter_key = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AuthParameter' {Maybe Text
key :: Maybe Text
$sel:key:AuthParameter' :: AuthParameter -> Maybe Text
key} -> Maybe Text
key) (\s :: AuthParameter
s@AuthParameter' {} Maybe Text
a -> AuthParameter
s {$sel:key:AuthParameter' :: Maybe Text
key = Maybe Text
a} :: AuthParameter)

-- | Label used for authentication parameter.
authParameter_label :: Lens.Lens' AuthParameter (Prelude.Maybe Prelude.Text)
authParameter_label :: Lens' AuthParameter (Maybe Text)
authParameter_label = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AuthParameter' {Maybe Text
label :: Maybe Text
$sel:label:AuthParameter' :: AuthParameter -> Maybe Text
label} -> Maybe Text
label) (\s :: AuthParameter
s@AuthParameter' {} Maybe Text
a -> AuthParameter
s {$sel:label:AuthParameter' :: Maybe Text
label = Maybe Text
a} :: AuthParameter)

instance Data.FromJSON AuthParameter where
  parseJSON :: Value -> Parser AuthParameter
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AuthParameter"
      ( \Object
x ->
          Maybe [Text]
-> Maybe Text
-> Maybe Bool
-> Maybe Bool
-> Maybe Text
-> Maybe Text
-> AuthParameter
AuthParameter'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"connectorSuppliedValues"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"description")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"isRequired")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"isSensitiveField")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"key")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"label")
      )

instance Prelude.Hashable AuthParameter where
  hashWithSalt :: Int -> AuthParameter -> Int
hashWithSalt Int
_salt AuthParameter' {Maybe Bool
Maybe [Text]
Maybe Text
label :: Maybe Text
key :: Maybe Text
isSensitiveField :: Maybe Bool
isRequired :: Maybe Bool
description :: Maybe Text
connectorSuppliedValues :: Maybe [Text]
$sel:label:AuthParameter' :: AuthParameter -> Maybe Text
$sel:key:AuthParameter' :: AuthParameter -> Maybe Text
$sel:isSensitiveField:AuthParameter' :: AuthParameter -> Maybe Bool
$sel:isRequired:AuthParameter' :: AuthParameter -> Maybe Bool
$sel:description:AuthParameter' :: AuthParameter -> Maybe Text
$sel:connectorSuppliedValues:AuthParameter' :: AuthParameter -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
connectorSuppliedValues
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
isRequired
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
isSensitiveField
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
key
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
label

instance Prelude.NFData AuthParameter where
  rnf :: AuthParameter -> ()
rnf AuthParameter' {Maybe Bool
Maybe [Text]
Maybe Text
label :: Maybe Text
key :: Maybe Text
isSensitiveField :: Maybe Bool
isRequired :: Maybe Bool
description :: Maybe Text
connectorSuppliedValues :: Maybe [Text]
$sel:label:AuthParameter' :: AuthParameter -> Maybe Text
$sel:key:AuthParameter' :: AuthParameter -> Maybe Text
$sel:isSensitiveField:AuthParameter' :: AuthParameter -> Maybe Bool
$sel:isRequired:AuthParameter' :: AuthParameter -> Maybe Bool
$sel:description:AuthParameter' :: AuthParameter -> Maybe Text
$sel:connectorSuppliedValues:AuthParameter' :: AuthParameter -> Maybe [Text]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
connectorSuppliedValues
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
isRequired
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
isSensitiveField
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
key
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
label