{-# 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.Kendra.Types.CapacityUnitsConfiguration
-- 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.Kendra.Types.CapacityUnitsConfiguration 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

-- | Specifies additional capacity units configured for your Enterprise
-- Edition index. You can add and remove capacity units to fit your usage
-- requirements.
--
-- /See:/ 'newCapacityUnitsConfiguration' smart constructor.
data CapacityUnitsConfiguration = CapacityUnitsConfiguration'
  { -- | The amount of extra storage capacity for an index. A single capacity
    -- unit provides 30 GB of storage space or 100,000 documents, whichever is
    -- reached first. You can add up to 100 extra capacity units.
    CapacityUnitsConfiguration -> Natural
storageCapacityUnits :: Prelude.Natural,
    -- | The amount of extra query capacity for an index and
    -- <https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html GetQuerySuggestions>
    -- capacity.
    --
    -- A single extra capacity unit for an index provides 0.1 queries per
    -- second or approximately 8,000 queries per day. You can add up to 100
    -- extra capacity units.
    --
    -- @GetQuerySuggestions@ capacity is five times the provisioned query
    -- capacity for an index, or the base capacity of 2.5 calls per second,
    -- whichever is higher. For example, the base capacity for an index is 0.1
    -- queries per second, and @GetQuerySuggestions@ capacity has a base of 2.5
    -- calls per second. If you add another 0.1 queries per second to total 0.2
    -- queries per second for an index, the @GetQuerySuggestions@ capacity is
    -- 2.5 calls per second (higher than five times 0.2 queries per second).
    CapacityUnitsConfiguration -> Natural
queryCapacityUnits :: Prelude.Natural
  }
  deriving (CapacityUnitsConfiguration -> CapacityUnitsConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CapacityUnitsConfiguration -> CapacityUnitsConfiguration -> Bool
$c/= :: CapacityUnitsConfiguration -> CapacityUnitsConfiguration -> Bool
== :: CapacityUnitsConfiguration -> CapacityUnitsConfiguration -> Bool
$c== :: CapacityUnitsConfiguration -> CapacityUnitsConfiguration -> Bool
Prelude.Eq, ReadPrec [CapacityUnitsConfiguration]
ReadPrec CapacityUnitsConfiguration
Int -> ReadS CapacityUnitsConfiguration
ReadS [CapacityUnitsConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CapacityUnitsConfiguration]
$creadListPrec :: ReadPrec [CapacityUnitsConfiguration]
readPrec :: ReadPrec CapacityUnitsConfiguration
$creadPrec :: ReadPrec CapacityUnitsConfiguration
readList :: ReadS [CapacityUnitsConfiguration]
$creadList :: ReadS [CapacityUnitsConfiguration]
readsPrec :: Int -> ReadS CapacityUnitsConfiguration
$creadsPrec :: Int -> ReadS CapacityUnitsConfiguration
Prelude.Read, Int -> CapacityUnitsConfiguration -> ShowS
[CapacityUnitsConfiguration] -> ShowS
CapacityUnitsConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CapacityUnitsConfiguration] -> ShowS
$cshowList :: [CapacityUnitsConfiguration] -> ShowS
show :: CapacityUnitsConfiguration -> String
$cshow :: CapacityUnitsConfiguration -> String
showsPrec :: Int -> CapacityUnitsConfiguration -> ShowS
$cshowsPrec :: Int -> CapacityUnitsConfiguration -> ShowS
Prelude.Show, forall x.
Rep CapacityUnitsConfiguration x -> CapacityUnitsConfiguration
forall x.
CapacityUnitsConfiguration -> Rep CapacityUnitsConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CapacityUnitsConfiguration x -> CapacityUnitsConfiguration
$cfrom :: forall x.
CapacityUnitsConfiguration -> Rep CapacityUnitsConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'CapacityUnitsConfiguration' 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:
--
-- 'storageCapacityUnits', 'capacityUnitsConfiguration_storageCapacityUnits' - The amount of extra storage capacity for an index. A single capacity
-- unit provides 30 GB of storage space or 100,000 documents, whichever is
-- reached first. You can add up to 100 extra capacity units.
--
-- 'queryCapacityUnits', 'capacityUnitsConfiguration_queryCapacityUnits' - The amount of extra query capacity for an index and
-- <https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html GetQuerySuggestions>
-- capacity.
--
-- A single extra capacity unit for an index provides 0.1 queries per
-- second or approximately 8,000 queries per day. You can add up to 100
-- extra capacity units.
--
-- @GetQuerySuggestions@ capacity is five times the provisioned query
-- capacity for an index, or the base capacity of 2.5 calls per second,
-- whichever is higher. For example, the base capacity for an index is 0.1
-- queries per second, and @GetQuerySuggestions@ capacity has a base of 2.5
-- calls per second. If you add another 0.1 queries per second to total 0.2
-- queries per second for an index, the @GetQuerySuggestions@ capacity is
-- 2.5 calls per second (higher than five times 0.2 queries per second).
newCapacityUnitsConfiguration ::
  -- | 'storageCapacityUnits'
  Prelude.Natural ->
  -- | 'queryCapacityUnits'
  Prelude.Natural ->
  CapacityUnitsConfiguration
newCapacityUnitsConfiguration :: Natural -> Natural -> CapacityUnitsConfiguration
newCapacityUnitsConfiguration
  Natural
pStorageCapacityUnits_
  Natural
pQueryCapacityUnits_ =
    CapacityUnitsConfiguration'
      { $sel:storageCapacityUnits:CapacityUnitsConfiguration' :: Natural
storageCapacityUnits =
          Natural
pStorageCapacityUnits_,
        $sel:queryCapacityUnits:CapacityUnitsConfiguration' :: Natural
queryCapacityUnits = Natural
pQueryCapacityUnits_
      }

-- | The amount of extra storage capacity for an index. A single capacity
-- unit provides 30 GB of storage space or 100,000 documents, whichever is
-- reached first. You can add up to 100 extra capacity units.
capacityUnitsConfiguration_storageCapacityUnits :: Lens.Lens' CapacityUnitsConfiguration Prelude.Natural
capacityUnitsConfiguration_storageCapacityUnits :: Lens' CapacityUnitsConfiguration Natural
capacityUnitsConfiguration_storageCapacityUnits = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CapacityUnitsConfiguration' {Natural
storageCapacityUnits :: Natural
$sel:storageCapacityUnits:CapacityUnitsConfiguration' :: CapacityUnitsConfiguration -> Natural
storageCapacityUnits} -> Natural
storageCapacityUnits) (\s :: CapacityUnitsConfiguration
s@CapacityUnitsConfiguration' {} Natural
a -> CapacityUnitsConfiguration
s {$sel:storageCapacityUnits:CapacityUnitsConfiguration' :: Natural
storageCapacityUnits = Natural
a} :: CapacityUnitsConfiguration)

-- | The amount of extra query capacity for an index and
-- <https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html GetQuerySuggestions>
-- capacity.
--
-- A single extra capacity unit for an index provides 0.1 queries per
-- second or approximately 8,000 queries per day. You can add up to 100
-- extra capacity units.
--
-- @GetQuerySuggestions@ capacity is five times the provisioned query
-- capacity for an index, or the base capacity of 2.5 calls per second,
-- whichever is higher. For example, the base capacity for an index is 0.1
-- queries per second, and @GetQuerySuggestions@ capacity has a base of 2.5
-- calls per second. If you add another 0.1 queries per second to total 0.2
-- queries per second for an index, the @GetQuerySuggestions@ capacity is
-- 2.5 calls per second (higher than five times 0.2 queries per second).
capacityUnitsConfiguration_queryCapacityUnits :: Lens.Lens' CapacityUnitsConfiguration Prelude.Natural
capacityUnitsConfiguration_queryCapacityUnits :: Lens' CapacityUnitsConfiguration Natural
capacityUnitsConfiguration_queryCapacityUnits = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CapacityUnitsConfiguration' {Natural
queryCapacityUnits :: Natural
$sel:queryCapacityUnits:CapacityUnitsConfiguration' :: CapacityUnitsConfiguration -> Natural
queryCapacityUnits} -> Natural
queryCapacityUnits) (\s :: CapacityUnitsConfiguration
s@CapacityUnitsConfiguration' {} Natural
a -> CapacityUnitsConfiguration
s {$sel:queryCapacityUnits:CapacityUnitsConfiguration' :: Natural
queryCapacityUnits = Natural
a} :: CapacityUnitsConfiguration)

instance Data.FromJSON CapacityUnitsConfiguration where
  parseJSON :: Value -> Parser CapacityUnitsConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CapacityUnitsConfiguration"
      ( \Object
x ->
          Natural -> Natural -> CapacityUnitsConfiguration
CapacityUnitsConfiguration'
            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
"StorageCapacityUnits")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"QueryCapacityUnits")
      )

instance Prelude.Hashable CapacityUnitsConfiguration where
  hashWithSalt :: Int -> CapacityUnitsConfiguration -> Int
hashWithSalt Int
_salt CapacityUnitsConfiguration' {Natural
queryCapacityUnits :: Natural
storageCapacityUnits :: Natural
$sel:queryCapacityUnits:CapacityUnitsConfiguration' :: CapacityUnitsConfiguration -> Natural
$sel:storageCapacityUnits:CapacityUnitsConfiguration' :: CapacityUnitsConfiguration -> Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
storageCapacityUnits
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Natural
queryCapacityUnits

instance Prelude.NFData CapacityUnitsConfiguration where
  rnf :: CapacityUnitsConfiguration -> ()
rnf CapacityUnitsConfiguration' {Natural
queryCapacityUnits :: Natural
storageCapacityUnits :: Natural
$sel:queryCapacityUnits:CapacityUnitsConfiguration' :: CapacityUnitsConfiguration -> Natural
$sel:storageCapacityUnits:CapacityUnitsConfiguration' :: CapacityUnitsConfiguration -> Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Natural
storageCapacityUnits
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Natural
queryCapacityUnits

instance Data.ToJSON CapacityUnitsConfiguration where
  toJSON :: CapacityUnitsConfiguration -> Value
toJSON CapacityUnitsConfiguration' {Natural
queryCapacityUnits :: Natural
storageCapacityUnits :: Natural
$sel:queryCapacityUnits:CapacityUnitsConfiguration' :: CapacityUnitsConfiguration -> Natural
$sel:storageCapacityUnits:CapacityUnitsConfiguration' :: CapacityUnitsConfiguration -> Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              ( Key
"StorageCapacityUnits"
                  forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Natural
storageCapacityUnits
              ),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"QueryCapacityUnits" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Natural
queryCapacityUnits)
          ]
      )