{-# 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.IoT.Types.FirehoseAction
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.IoT.Types.FirehoseAction where

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

-- | Describes an action that writes data to an Amazon Kinesis Firehose
-- stream.
--
-- /See:/ 'newFirehoseAction' smart constructor.
data FirehoseAction = FirehoseAction'
  { -- | Whether to deliver the Kinesis Data Firehose stream as a batch by using
    -- <https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html PutRecordBatch>
    -- . The default value is @false@.
    --
    -- When @batchMode@ is @true@ and the rule\'s SQL statement evaluates to an
    -- Array, each Array element forms one record in the
    -- <https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html PutRecordBatch>
    -- request. The resulting array can\'t have more than 500 records.
    FirehoseAction -> Maybe Bool
batchMode :: Prelude.Maybe Prelude.Bool,
    -- | A character separator that will be used to separate records written to
    -- the Firehose stream. Valid values are: \'\\n\' (newline), \'\\t\' (tab),
    -- \'\\r\\n\' (Windows newline), \',\' (comma).
    FirehoseAction -> Maybe Text
separator :: Prelude.Maybe Prelude.Text,
    -- | The IAM role that grants access to the Amazon Kinesis Firehose stream.
    FirehoseAction -> Text
roleArn :: Prelude.Text,
    -- | The delivery stream name.
    FirehoseAction -> Text
deliveryStreamName :: Prelude.Text
  }
  deriving (FirehoseAction -> FirehoseAction -> Bool
(FirehoseAction -> FirehoseAction -> Bool)
-> (FirehoseAction -> FirehoseAction -> Bool) -> Eq FirehoseAction
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FirehoseAction -> FirehoseAction -> Bool
$c/= :: FirehoseAction -> FirehoseAction -> Bool
== :: FirehoseAction -> FirehoseAction -> Bool
$c== :: FirehoseAction -> FirehoseAction -> Bool
Prelude.Eq, ReadPrec [FirehoseAction]
ReadPrec FirehoseAction
Int -> ReadS FirehoseAction
ReadS [FirehoseAction]
(Int -> ReadS FirehoseAction)
-> ReadS [FirehoseAction]
-> ReadPrec FirehoseAction
-> ReadPrec [FirehoseAction]
-> Read FirehoseAction
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [FirehoseAction]
$creadListPrec :: ReadPrec [FirehoseAction]
readPrec :: ReadPrec FirehoseAction
$creadPrec :: ReadPrec FirehoseAction
readList :: ReadS [FirehoseAction]
$creadList :: ReadS [FirehoseAction]
readsPrec :: Int -> ReadS FirehoseAction
$creadsPrec :: Int -> ReadS FirehoseAction
Prelude.Read, Int -> FirehoseAction -> ShowS
[FirehoseAction] -> ShowS
FirehoseAction -> String
(Int -> FirehoseAction -> ShowS)
-> (FirehoseAction -> String)
-> ([FirehoseAction] -> ShowS)
-> Show FirehoseAction
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [FirehoseAction] -> ShowS
$cshowList :: [FirehoseAction] -> ShowS
show :: FirehoseAction -> String
$cshow :: FirehoseAction -> String
showsPrec :: Int -> FirehoseAction -> ShowS
$cshowsPrec :: Int -> FirehoseAction -> ShowS
Prelude.Show, (forall x. FirehoseAction -> Rep FirehoseAction x)
-> (forall x. Rep FirehoseAction x -> FirehoseAction)
-> Generic FirehoseAction
forall x. Rep FirehoseAction x -> FirehoseAction
forall x. FirehoseAction -> Rep FirehoseAction x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep FirehoseAction x -> FirehoseAction
$cfrom :: forall x. FirehoseAction -> Rep FirehoseAction x
Prelude.Generic)

-- |
-- Create a value of 'FirehoseAction' 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:
--
-- 'batchMode', 'firehoseAction_batchMode' - Whether to deliver the Kinesis Data Firehose stream as a batch by using
-- <https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html PutRecordBatch>
-- . The default value is @false@.
--
-- When @batchMode@ is @true@ and the rule\'s SQL statement evaluates to an
-- Array, each Array element forms one record in the
-- <https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html PutRecordBatch>
-- request. The resulting array can\'t have more than 500 records.
--
-- 'separator', 'firehoseAction_separator' - A character separator that will be used to separate records written to
-- the Firehose stream. Valid values are: \'\\n\' (newline), \'\\t\' (tab),
-- \'\\r\\n\' (Windows newline), \',\' (comma).
--
-- 'roleArn', 'firehoseAction_roleArn' - The IAM role that grants access to the Amazon Kinesis Firehose stream.
--
-- 'deliveryStreamName', 'firehoseAction_deliveryStreamName' - The delivery stream name.
newFirehoseAction ::
  -- | 'roleArn'
  Prelude.Text ->
  -- | 'deliveryStreamName'
  Prelude.Text ->
  FirehoseAction
newFirehoseAction :: Text -> Text -> FirehoseAction
newFirehoseAction Text
pRoleArn_ Text
pDeliveryStreamName_ =
  FirehoseAction' :: Maybe Bool -> Maybe Text -> Text -> Text -> FirehoseAction
FirehoseAction'
    { $sel:batchMode:FirehoseAction' :: Maybe Bool
batchMode = Maybe Bool
forall a. Maybe a
Prelude.Nothing,
      $sel:separator:FirehoseAction' :: Maybe Text
separator = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:roleArn:FirehoseAction' :: Text
roleArn = Text
pRoleArn_,
      $sel:deliveryStreamName:FirehoseAction' :: Text
deliveryStreamName = Text
pDeliveryStreamName_
    }

-- | Whether to deliver the Kinesis Data Firehose stream as a batch by using
-- <https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html PutRecordBatch>
-- . The default value is @false@.
--
-- When @batchMode@ is @true@ and the rule\'s SQL statement evaluates to an
-- Array, each Array element forms one record in the
-- <https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html PutRecordBatch>
-- request. The resulting array can\'t have more than 500 records.
firehoseAction_batchMode :: Lens.Lens' FirehoseAction (Prelude.Maybe Prelude.Bool)
firehoseAction_batchMode :: (Maybe Bool -> f (Maybe Bool))
-> FirehoseAction -> f FirehoseAction
firehoseAction_batchMode = (FirehoseAction -> Maybe Bool)
-> (FirehoseAction -> Maybe Bool -> FirehoseAction)
-> Lens FirehoseAction FirehoseAction (Maybe Bool) (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FirehoseAction' {Maybe Bool
batchMode :: Maybe Bool
$sel:batchMode:FirehoseAction' :: FirehoseAction -> Maybe Bool
batchMode} -> Maybe Bool
batchMode) (\s :: FirehoseAction
s@FirehoseAction' {} Maybe Bool
a -> FirehoseAction
s {$sel:batchMode:FirehoseAction' :: Maybe Bool
batchMode = Maybe Bool
a} :: FirehoseAction)

-- | A character separator that will be used to separate records written to
-- the Firehose stream. Valid values are: \'\\n\' (newline), \'\\t\' (tab),
-- \'\\r\\n\' (Windows newline), \',\' (comma).
firehoseAction_separator :: Lens.Lens' FirehoseAction (Prelude.Maybe Prelude.Text)
firehoseAction_separator :: (Maybe Text -> f (Maybe Text))
-> FirehoseAction -> f FirehoseAction
firehoseAction_separator = (FirehoseAction -> Maybe Text)
-> (FirehoseAction -> Maybe Text -> FirehoseAction)
-> Lens FirehoseAction FirehoseAction (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FirehoseAction' {Maybe Text
separator :: Maybe Text
$sel:separator:FirehoseAction' :: FirehoseAction -> Maybe Text
separator} -> Maybe Text
separator) (\s :: FirehoseAction
s@FirehoseAction' {} Maybe Text
a -> FirehoseAction
s {$sel:separator:FirehoseAction' :: Maybe Text
separator = Maybe Text
a} :: FirehoseAction)

-- | The IAM role that grants access to the Amazon Kinesis Firehose stream.
firehoseAction_roleArn :: Lens.Lens' FirehoseAction Prelude.Text
firehoseAction_roleArn :: (Text -> f Text) -> FirehoseAction -> f FirehoseAction
firehoseAction_roleArn = (FirehoseAction -> Text)
-> (FirehoseAction -> Text -> FirehoseAction)
-> Lens FirehoseAction FirehoseAction Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FirehoseAction' {Text
roleArn :: Text
$sel:roleArn:FirehoseAction' :: FirehoseAction -> Text
roleArn} -> Text
roleArn) (\s :: FirehoseAction
s@FirehoseAction' {} Text
a -> FirehoseAction
s {$sel:roleArn:FirehoseAction' :: Text
roleArn = Text
a} :: FirehoseAction)

-- | The delivery stream name.
firehoseAction_deliveryStreamName :: Lens.Lens' FirehoseAction Prelude.Text
firehoseAction_deliveryStreamName :: (Text -> f Text) -> FirehoseAction -> f FirehoseAction
firehoseAction_deliveryStreamName = (FirehoseAction -> Text)
-> (FirehoseAction -> Text -> FirehoseAction)
-> Lens FirehoseAction FirehoseAction Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FirehoseAction' {Text
deliveryStreamName :: Text
$sel:deliveryStreamName:FirehoseAction' :: FirehoseAction -> Text
deliveryStreamName} -> Text
deliveryStreamName) (\s :: FirehoseAction
s@FirehoseAction' {} Text
a -> FirehoseAction
s {$sel:deliveryStreamName:FirehoseAction' :: Text
deliveryStreamName = Text
a} :: FirehoseAction)

instance Core.FromJSON FirehoseAction where
  parseJSON :: Value -> Parser FirehoseAction
parseJSON =
    String
-> (Object -> Parser FirehoseAction)
-> Value
-> Parser FirehoseAction
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"FirehoseAction"
      ( \Object
x ->
          Maybe Bool -> Maybe Text -> Text -> Text -> FirehoseAction
FirehoseAction'
            (Maybe Bool -> Maybe Text -> Text -> Text -> FirehoseAction)
-> Parser (Maybe Bool)
-> Parser (Maybe Text -> Text -> Text -> FirehoseAction)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe Bool)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"batchMode")
            Parser (Maybe Text -> Text -> Text -> FirehoseAction)
-> Parser (Maybe Text) -> Parser (Text -> Text -> FirehoseAction)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"separator")
            Parser (Text -> Text -> FirehoseAction)
-> Parser Text -> Parser (Text -> FirehoseAction)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser Text
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"roleArn")
            Parser (Text -> FirehoseAction)
-> Parser Text -> Parser FirehoseAction
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser Text
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"deliveryStreamName")
      )

instance Prelude.Hashable FirehoseAction

instance Prelude.NFData FirehoseAction

instance Core.ToJSON FirehoseAction where
  toJSON :: FirehoseAction -> Value
toJSON FirehoseAction' {Maybe Bool
Maybe Text
Text
deliveryStreamName :: Text
roleArn :: Text
separator :: Maybe Text
batchMode :: Maybe Bool
$sel:deliveryStreamName:FirehoseAction' :: FirehoseAction -> Text
$sel:roleArn:FirehoseAction' :: FirehoseAction -> Text
$sel:separator:FirehoseAction' :: FirehoseAction -> Maybe Text
$sel:batchMode:FirehoseAction' :: FirehoseAction -> Maybe Bool
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"batchMode" Text -> Bool -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Bool -> Pair) -> Maybe Bool -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
batchMode,
            (Text
"separator" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
separator,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"roleArn" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
roleArn),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"deliveryStreamName" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
deliveryStreamName)
          ]
      )