{-# 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.CognitoIdentityProvider.Types.AnalyticsConfigurationType
-- 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.CognitoIdentityProvider.Types.AnalyticsConfigurationType 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

-- | The Amazon Pinpoint analytics configuration necessary to collect metrics
-- for a user pool.
--
-- In Regions where Amazon Pinpointisn\'t available, user pools only
-- support sending events to Amazon Pinpoint projects in us-east-1. In
-- Regions where Amazon Pinpoint is available, user pools support sending
-- events to Amazon Pinpoint projects within that same Region.
--
-- /See:/ 'newAnalyticsConfigurationType' smart constructor.
data AnalyticsConfigurationType = AnalyticsConfigurationType'
  { -- | The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can
    -- use the Amazon Pinpoint project to integrate with the chosen user pool
    -- Client. Amazon Cognito publishes events to the Amazon Pinpoint project
    -- that the app ARN declares.
    AnalyticsConfigurationType -> Maybe Text
applicationArn :: Prelude.Maybe Prelude.Text,
    -- | The application ID for an Amazon Pinpoint application.
    AnalyticsConfigurationType -> Maybe Text
applicationId :: Prelude.Maybe Prelude.Text,
    -- | The external ID.
    AnalyticsConfigurationType -> Maybe Text
externalId :: Prelude.Maybe Prelude.Text,
    -- | The ARN of an Identity and Access Management role that authorizes Amazon
    -- Cognito to publish events to Amazon Pinpoint analytics.
    AnalyticsConfigurationType -> Maybe Text
roleArn :: Prelude.Maybe Prelude.Text,
    -- | If @UserDataShared@ is @true@, Amazon Cognito includes user data in the
    -- events that it publishes to Amazon Pinpoint analytics.
    AnalyticsConfigurationType -> Maybe Bool
userDataShared :: Prelude.Maybe Prelude.Bool
  }
  deriving (AnalyticsConfigurationType -> AnalyticsConfigurationType -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AnalyticsConfigurationType -> AnalyticsConfigurationType -> Bool
$c/= :: AnalyticsConfigurationType -> AnalyticsConfigurationType -> Bool
== :: AnalyticsConfigurationType -> AnalyticsConfigurationType -> Bool
$c== :: AnalyticsConfigurationType -> AnalyticsConfigurationType -> Bool
Prelude.Eq, ReadPrec [AnalyticsConfigurationType]
ReadPrec AnalyticsConfigurationType
Int -> ReadS AnalyticsConfigurationType
ReadS [AnalyticsConfigurationType]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AnalyticsConfigurationType]
$creadListPrec :: ReadPrec [AnalyticsConfigurationType]
readPrec :: ReadPrec AnalyticsConfigurationType
$creadPrec :: ReadPrec AnalyticsConfigurationType
readList :: ReadS [AnalyticsConfigurationType]
$creadList :: ReadS [AnalyticsConfigurationType]
readsPrec :: Int -> ReadS AnalyticsConfigurationType
$creadsPrec :: Int -> ReadS AnalyticsConfigurationType
Prelude.Read, Int -> AnalyticsConfigurationType -> ShowS
[AnalyticsConfigurationType] -> ShowS
AnalyticsConfigurationType -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AnalyticsConfigurationType] -> ShowS
$cshowList :: [AnalyticsConfigurationType] -> ShowS
show :: AnalyticsConfigurationType -> String
$cshow :: AnalyticsConfigurationType -> String
showsPrec :: Int -> AnalyticsConfigurationType -> ShowS
$cshowsPrec :: Int -> AnalyticsConfigurationType -> ShowS
Prelude.Show, forall x.
Rep AnalyticsConfigurationType x -> AnalyticsConfigurationType
forall x.
AnalyticsConfigurationType -> Rep AnalyticsConfigurationType x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep AnalyticsConfigurationType x -> AnalyticsConfigurationType
$cfrom :: forall x.
AnalyticsConfigurationType -> Rep AnalyticsConfigurationType x
Prelude.Generic)

-- |
-- Create a value of 'AnalyticsConfigurationType' 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:
--
-- 'applicationArn', 'analyticsConfigurationType_applicationArn' - The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can
-- use the Amazon Pinpoint project to integrate with the chosen user pool
-- Client. Amazon Cognito publishes events to the Amazon Pinpoint project
-- that the app ARN declares.
--
-- 'applicationId', 'analyticsConfigurationType_applicationId' - The application ID for an Amazon Pinpoint application.
--
-- 'externalId', 'analyticsConfigurationType_externalId' - The external ID.
--
-- 'roleArn', 'analyticsConfigurationType_roleArn' - The ARN of an Identity and Access Management role that authorizes Amazon
-- Cognito to publish events to Amazon Pinpoint analytics.
--
-- 'userDataShared', 'analyticsConfigurationType_userDataShared' - If @UserDataShared@ is @true@, Amazon Cognito includes user data in the
-- events that it publishes to Amazon Pinpoint analytics.
newAnalyticsConfigurationType ::
  AnalyticsConfigurationType
newAnalyticsConfigurationType :: AnalyticsConfigurationType
newAnalyticsConfigurationType =
  AnalyticsConfigurationType'
    { $sel:applicationArn:AnalyticsConfigurationType' :: Maybe Text
applicationArn =
        forall a. Maybe a
Prelude.Nothing,
      $sel:applicationId:AnalyticsConfigurationType' :: Maybe Text
applicationId = forall a. Maybe a
Prelude.Nothing,
      $sel:externalId:AnalyticsConfigurationType' :: Maybe Text
externalId = forall a. Maybe a
Prelude.Nothing,
      $sel:roleArn:AnalyticsConfigurationType' :: Maybe Text
roleArn = forall a. Maybe a
Prelude.Nothing,
      $sel:userDataShared:AnalyticsConfigurationType' :: Maybe Bool
userDataShared = forall a. Maybe a
Prelude.Nothing
    }

-- | The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can
-- use the Amazon Pinpoint project to integrate with the chosen user pool
-- Client. Amazon Cognito publishes events to the Amazon Pinpoint project
-- that the app ARN declares.
analyticsConfigurationType_applicationArn :: Lens.Lens' AnalyticsConfigurationType (Prelude.Maybe Prelude.Text)
analyticsConfigurationType_applicationArn :: Lens' AnalyticsConfigurationType (Maybe Text)
analyticsConfigurationType_applicationArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AnalyticsConfigurationType' {Maybe Text
applicationArn :: Maybe Text
$sel:applicationArn:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
applicationArn} -> Maybe Text
applicationArn) (\s :: AnalyticsConfigurationType
s@AnalyticsConfigurationType' {} Maybe Text
a -> AnalyticsConfigurationType
s {$sel:applicationArn:AnalyticsConfigurationType' :: Maybe Text
applicationArn = Maybe Text
a} :: AnalyticsConfigurationType)

-- | The application ID for an Amazon Pinpoint application.
analyticsConfigurationType_applicationId :: Lens.Lens' AnalyticsConfigurationType (Prelude.Maybe Prelude.Text)
analyticsConfigurationType_applicationId :: Lens' AnalyticsConfigurationType (Maybe Text)
analyticsConfigurationType_applicationId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AnalyticsConfigurationType' {Maybe Text
applicationId :: Maybe Text
$sel:applicationId:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
applicationId} -> Maybe Text
applicationId) (\s :: AnalyticsConfigurationType
s@AnalyticsConfigurationType' {} Maybe Text
a -> AnalyticsConfigurationType
s {$sel:applicationId:AnalyticsConfigurationType' :: Maybe Text
applicationId = Maybe Text
a} :: AnalyticsConfigurationType)

-- | The external ID.
analyticsConfigurationType_externalId :: Lens.Lens' AnalyticsConfigurationType (Prelude.Maybe Prelude.Text)
analyticsConfigurationType_externalId :: Lens' AnalyticsConfigurationType (Maybe Text)
analyticsConfigurationType_externalId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AnalyticsConfigurationType' {Maybe Text
externalId :: Maybe Text
$sel:externalId:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
externalId} -> Maybe Text
externalId) (\s :: AnalyticsConfigurationType
s@AnalyticsConfigurationType' {} Maybe Text
a -> AnalyticsConfigurationType
s {$sel:externalId:AnalyticsConfigurationType' :: Maybe Text
externalId = Maybe Text
a} :: AnalyticsConfigurationType)

-- | The ARN of an Identity and Access Management role that authorizes Amazon
-- Cognito to publish events to Amazon Pinpoint analytics.
analyticsConfigurationType_roleArn :: Lens.Lens' AnalyticsConfigurationType (Prelude.Maybe Prelude.Text)
analyticsConfigurationType_roleArn :: Lens' AnalyticsConfigurationType (Maybe Text)
analyticsConfigurationType_roleArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AnalyticsConfigurationType' {Maybe Text
roleArn :: Maybe Text
$sel:roleArn:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
roleArn} -> Maybe Text
roleArn) (\s :: AnalyticsConfigurationType
s@AnalyticsConfigurationType' {} Maybe Text
a -> AnalyticsConfigurationType
s {$sel:roleArn:AnalyticsConfigurationType' :: Maybe Text
roleArn = Maybe Text
a} :: AnalyticsConfigurationType)

-- | If @UserDataShared@ is @true@, Amazon Cognito includes user data in the
-- events that it publishes to Amazon Pinpoint analytics.
analyticsConfigurationType_userDataShared :: Lens.Lens' AnalyticsConfigurationType (Prelude.Maybe Prelude.Bool)
analyticsConfigurationType_userDataShared :: Lens' AnalyticsConfigurationType (Maybe Bool)
analyticsConfigurationType_userDataShared = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AnalyticsConfigurationType' {Maybe Bool
userDataShared :: Maybe Bool
$sel:userDataShared:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Bool
userDataShared} -> Maybe Bool
userDataShared) (\s :: AnalyticsConfigurationType
s@AnalyticsConfigurationType' {} Maybe Bool
a -> AnalyticsConfigurationType
s {$sel:userDataShared:AnalyticsConfigurationType' :: Maybe Bool
userDataShared = Maybe Bool
a} :: AnalyticsConfigurationType)

instance Data.FromJSON AnalyticsConfigurationType where
  parseJSON :: Value -> Parser AnalyticsConfigurationType
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AnalyticsConfigurationType"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Bool
-> AnalyticsConfigurationType
AnalyticsConfigurationType'
            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
"ApplicationArn")
            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
"ApplicationId")
            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
"ExternalId")
            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
"RoleArn")
            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
"UserDataShared")
      )

instance Prelude.Hashable AnalyticsConfigurationType where
  hashWithSalt :: Int -> AnalyticsConfigurationType -> Int
hashWithSalt Int
_salt AnalyticsConfigurationType' {Maybe Bool
Maybe Text
userDataShared :: Maybe Bool
roleArn :: Maybe Text
externalId :: Maybe Text
applicationId :: Maybe Text
applicationArn :: Maybe Text
$sel:userDataShared:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Bool
$sel:roleArn:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
$sel:externalId:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
$sel:applicationId:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
$sel:applicationArn:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
applicationArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
applicationId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
externalId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
roleArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
userDataShared

instance Prelude.NFData AnalyticsConfigurationType where
  rnf :: AnalyticsConfigurationType -> ()
rnf AnalyticsConfigurationType' {Maybe Bool
Maybe Text
userDataShared :: Maybe Bool
roleArn :: Maybe Text
externalId :: Maybe Text
applicationId :: Maybe Text
applicationArn :: Maybe Text
$sel:userDataShared:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Bool
$sel:roleArn:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
$sel:externalId:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
$sel:applicationId:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
$sel:applicationArn:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
applicationArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
applicationId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
externalId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
roleArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
userDataShared

instance Data.ToJSON AnalyticsConfigurationType where
  toJSON :: AnalyticsConfigurationType -> Value
toJSON AnalyticsConfigurationType' {Maybe Bool
Maybe Text
userDataShared :: Maybe Bool
roleArn :: Maybe Text
externalId :: Maybe Text
applicationId :: Maybe Text
applicationArn :: Maybe Text
$sel:userDataShared:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Bool
$sel:roleArn:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
$sel:externalId:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
$sel:applicationId:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
$sel:applicationArn:AnalyticsConfigurationType' :: AnalyticsConfigurationType -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"ApplicationArn" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
applicationArn,
            (Key
"ApplicationId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
applicationId,
            (Key
"ExternalId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
externalId,
            (Key
"RoleArn" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
roleArn,
            (Key
"UserDataShared" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
userDataShared
          ]
      )