{-# 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.Pipes.Types.PipeTargetKinesisStreamParameters
-- 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.Pipes.Types.PipeTargetKinesisStreamParameters 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 parameters for using a Kinesis stream as a source.
--
-- /See:/ 'newPipeTargetKinesisStreamParameters' smart constructor.
data PipeTargetKinesisStreamParameters = PipeTargetKinesisStreamParameters'
  { -- | Determines which shard in the stream the data record is assigned to.
    -- Partition keys are Unicode strings with a maximum length limit of 256
    -- characters for each key. Amazon Kinesis Data Streams uses the partition
    -- key as input to a hash function that maps the partition key and
    -- associated data to a specific shard. Specifically, an MD5 hash function
    -- is used to map partition keys to 128-bit integer values and to map
    -- associated data records to shards. As a result of this hashing
    -- mechanism, all data records with the same partition key map to the same
    -- shard within the stream.
    PipeTargetKinesisStreamParameters -> Sensitive Text
partitionKey :: Data.Sensitive Prelude.Text
  }
  deriving (PipeTargetKinesisStreamParameters
-> PipeTargetKinesisStreamParameters -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PipeTargetKinesisStreamParameters
-> PipeTargetKinesisStreamParameters -> Bool
$c/= :: PipeTargetKinesisStreamParameters
-> PipeTargetKinesisStreamParameters -> Bool
== :: PipeTargetKinesisStreamParameters
-> PipeTargetKinesisStreamParameters -> Bool
$c== :: PipeTargetKinesisStreamParameters
-> PipeTargetKinesisStreamParameters -> Bool
Prelude.Eq, Int -> PipeTargetKinesisStreamParameters -> ShowS
[PipeTargetKinesisStreamParameters] -> ShowS
PipeTargetKinesisStreamParameters -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PipeTargetKinesisStreamParameters] -> ShowS
$cshowList :: [PipeTargetKinesisStreamParameters] -> ShowS
show :: PipeTargetKinesisStreamParameters -> String
$cshow :: PipeTargetKinesisStreamParameters -> String
showsPrec :: Int -> PipeTargetKinesisStreamParameters -> ShowS
$cshowsPrec :: Int -> PipeTargetKinesisStreamParameters -> ShowS
Prelude.Show, forall x.
Rep PipeTargetKinesisStreamParameters x
-> PipeTargetKinesisStreamParameters
forall x.
PipeTargetKinesisStreamParameters
-> Rep PipeTargetKinesisStreamParameters x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep PipeTargetKinesisStreamParameters x
-> PipeTargetKinesisStreamParameters
$cfrom :: forall x.
PipeTargetKinesisStreamParameters
-> Rep PipeTargetKinesisStreamParameters x
Prelude.Generic)

-- |
-- Create a value of 'PipeTargetKinesisStreamParameters' 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:
--
-- 'partitionKey', 'pipeTargetKinesisStreamParameters_partitionKey' - Determines which shard in the stream the data record is assigned to.
-- Partition keys are Unicode strings with a maximum length limit of 256
-- characters for each key. Amazon Kinesis Data Streams uses the partition
-- key as input to a hash function that maps the partition key and
-- associated data to a specific shard. Specifically, an MD5 hash function
-- is used to map partition keys to 128-bit integer values and to map
-- associated data records to shards. As a result of this hashing
-- mechanism, all data records with the same partition key map to the same
-- shard within the stream.
newPipeTargetKinesisStreamParameters ::
  -- | 'partitionKey'
  Prelude.Text ->
  PipeTargetKinesisStreamParameters
newPipeTargetKinesisStreamParameters :: Text -> PipeTargetKinesisStreamParameters
newPipeTargetKinesisStreamParameters Text
pPartitionKey_ =
  PipeTargetKinesisStreamParameters'
    { $sel:partitionKey:PipeTargetKinesisStreamParameters' :: Sensitive Text
partitionKey =
        forall a. Iso' (Sensitive a) a
Data._Sensitive forall t b. AReview t b -> b -> t
Lens.# Text
pPartitionKey_
    }

-- | Determines which shard in the stream the data record is assigned to.
-- Partition keys are Unicode strings with a maximum length limit of 256
-- characters for each key. Amazon Kinesis Data Streams uses the partition
-- key as input to a hash function that maps the partition key and
-- associated data to a specific shard. Specifically, an MD5 hash function
-- is used to map partition keys to 128-bit integer values and to map
-- associated data records to shards. As a result of this hashing
-- mechanism, all data records with the same partition key map to the same
-- shard within the stream.
pipeTargetKinesisStreamParameters_partitionKey :: Lens.Lens' PipeTargetKinesisStreamParameters Prelude.Text
pipeTargetKinesisStreamParameters_partitionKey :: Lens' PipeTargetKinesisStreamParameters Text
pipeTargetKinesisStreamParameters_partitionKey = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PipeTargetKinesisStreamParameters' {Sensitive Text
partitionKey :: Sensitive Text
$sel:partitionKey:PipeTargetKinesisStreamParameters' :: PipeTargetKinesisStreamParameters -> Sensitive Text
partitionKey} -> Sensitive Text
partitionKey) (\s :: PipeTargetKinesisStreamParameters
s@PipeTargetKinesisStreamParameters' {} Sensitive Text
a -> PipeTargetKinesisStreamParameters
s {$sel:partitionKey:PipeTargetKinesisStreamParameters' :: Sensitive Text
partitionKey = Sensitive Text
a} :: PipeTargetKinesisStreamParameters) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. Iso' (Sensitive a) a
Data._Sensitive

instance
  Data.FromJSON
    PipeTargetKinesisStreamParameters
  where
  parseJSON :: Value -> Parser PipeTargetKinesisStreamParameters
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PipeTargetKinesisStreamParameters"
      ( \Object
x ->
          Sensitive Text -> PipeTargetKinesisStreamParameters
PipeTargetKinesisStreamParameters'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"PartitionKey")
      )

instance
  Prelude.Hashable
    PipeTargetKinesisStreamParameters
  where
  hashWithSalt :: Int -> PipeTargetKinesisStreamParameters -> Int
hashWithSalt
    Int
_salt
    PipeTargetKinesisStreamParameters' {Sensitive Text
partitionKey :: Sensitive Text
$sel:partitionKey:PipeTargetKinesisStreamParameters' :: PipeTargetKinesisStreamParameters -> Sensitive Text
..} =
      Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Sensitive Text
partitionKey

instance
  Prelude.NFData
    PipeTargetKinesisStreamParameters
  where
  rnf :: PipeTargetKinesisStreamParameters -> ()
rnf PipeTargetKinesisStreamParameters' {Sensitive Text
partitionKey :: Sensitive Text
$sel:partitionKey:PipeTargetKinesisStreamParameters' :: PipeTargetKinesisStreamParameters -> Sensitive Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Sensitive Text
partitionKey

instance
  Data.ToJSON
    PipeTargetKinesisStreamParameters
  where
  toJSON :: PipeTargetKinesisStreamParameters -> Value
toJSON PipeTargetKinesisStreamParameters' {Sensitive Text
partitionKey :: Sensitive Text
$sel:partitionKey:PipeTargetKinesisStreamParameters' :: PipeTargetKinesisStreamParameters -> Sensitive Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [forall a. a -> Maybe a
Prelude.Just (Key
"PartitionKey" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Sensitive Text
partitionKey)]
      )