{-# 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.GameLift.Types.FilterConfiguration
-- 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.GameLift.Types.FilterConfiguration where

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

-- | A list of fleet locations where a game session queue can place new game
-- sessions. You can use a filter to temporarily turn off placements for
-- specific locations. For queues that have multi-location fleets, you can
-- use a filter configuration allow placement with some, but not all of
-- these locations.
--
-- Filter configurations are part of a GameSessionQueue.
--
-- /See:/ 'newFilterConfiguration' smart constructor.
data FilterConfiguration = FilterConfiguration'
  { -- | A list of locations to allow game session placement in, in the form of
    -- AWS Region codes such as @us-west-2@.
    FilterConfiguration -> Maybe (NonEmpty Text)
allowedLocations :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text)
  }
  deriving (FilterConfiguration -> FilterConfiguration -> Bool
(FilterConfiguration -> FilterConfiguration -> Bool)
-> (FilterConfiguration -> FilterConfiguration -> Bool)
-> Eq FilterConfiguration
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FilterConfiguration -> FilterConfiguration -> Bool
$c/= :: FilterConfiguration -> FilterConfiguration -> Bool
== :: FilterConfiguration -> FilterConfiguration -> Bool
$c== :: FilterConfiguration -> FilterConfiguration -> Bool
Prelude.Eq, ReadPrec [FilterConfiguration]
ReadPrec FilterConfiguration
Int -> ReadS FilterConfiguration
ReadS [FilterConfiguration]
(Int -> ReadS FilterConfiguration)
-> ReadS [FilterConfiguration]
-> ReadPrec FilterConfiguration
-> ReadPrec [FilterConfiguration]
-> Read FilterConfiguration
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [FilterConfiguration]
$creadListPrec :: ReadPrec [FilterConfiguration]
readPrec :: ReadPrec FilterConfiguration
$creadPrec :: ReadPrec FilterConfiguration
readList :: ReadS [FilterConfiguration]
$creadList :: ReadS [FilterConfiguration]
readsPrec :: Int -> ReadS FilterConfiguration
$creadsPrec :: Int -> ReadS FilterConfiguration
Prelude.Read, Int -> FilterConfiguration -> ShowS
[FilterConfiguration] -> ShowS
FilterConfiguration -> String
(Int -> FilterConfiguration -> ShowS)
-> (FilterConfiguration -> String)
-> ([FilterConfiguration] -> ShowS)
-> Show FilterConfiguration
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [FilterConfiguration] -> ShowS
$cshowList :: [FilterConfiguration] -> ShowS
show :: FilterConfiguration -> String
$cshow :: FilterConfiguration -> String
showsPrec :: Int -> FilterConfiguration -> ShowS
$cshowsPrec :: Int -> FilterConfiguration -> ShowS
Prelude.Show, (forall x. FilterConfiguration -> Rep FilterConfiguration x)
-> (forall x. Rep FilterConfiguration x -> FilterConfiguration)
-> Generic FilterConfiguration
forall x. Rep FilterConfiguration x -> FilterConfiguration
forall x. FilterConfiguration -> Rep FilterConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep FilterConfiguration x -> FilterConfiguration
$cfrom :: forall x. FilterConfiguration -> Rep FilterConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'FilterConfiguration' 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:
--
-- 'allowedLocations', 'filterConfiguration_allowedLocations' - A list of locations to allow game session placement in, in the form of
-- AWS Region codes such as @us-west-2@.
newFilterConfiguration ::
  FilterConfiguration
newFilterConfiguration :: FilterConfiguration
newFilterConfiguration =
  FilterConfiguration' :: Maybe (NonEmpty Text) -> FilterConfiguration
FilterConfiguration'
    { $sel:allowedLocations:FilterConfiguration' :: Maybe (NonEmpty Text)
allowedLocations =
        Maybe (NonEmpty Text)
forall a. Maybe a
Prelude.Nothing
    }

-- | A list of locations to allow game session placement in, in the form of
-- AWS Region codes such as @us-west-2@.
filterConfiguration_allowedLocations :: Lens.Lens' FilterConfiguration (Prelude.Maybe (Prelude.NonEmpty Prelude.Text))
filterConfiguration_allowedLocations :: (Maybe (NonEmpty Text) -> f (Maybe (NonEmpty Text)))
-> FilterConfiguration -> f FilterConfiguration
filterConfiguration_allowedLocations = (FilterConfiguration -> Maybe (NonEmpty Text))
-> (FilterConfiguration
    -> Maybe (NonEmpty Text) -> FilterConfiguration)
-> Lens
     FilterConfiguration
     FilterConfiguration
     (Maybe (NonEmpty Text))
     (Maybe (NonEmpty Text))
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FilterConfiguration' {Maybe (NonEmpty Text)
allowedLocations :: Maybe (NonEmpty Text)
$sel:allowedLocations:FilterConfiguration' :: FilterConfiguration -> Maybe (NonEmpty Text)
allowedLocations} -> Maybe (NonEmpty Text)
allowedLocations) (\s :: FilterConfiguration
s@FilterConfiguration' {} Maybe (NonEmpty Text)
a -> FilterConfiguration
s {$sel:allowedLocations:FilterConfiguration' :: Maybe (NonEmpty Text)
allowedLocations = Maybe (NonEmpty Text)
a} :: FilterConfiguration) ((Maybe (NonEmpty Text) -> f (Maybe (NonEmpty Text)))
 -> FilterConfiguration -> f FilterConfiguration)
-> ((Maybe (NonEmpty Text) -> f (Maybe (NonEmpty Text)))
    -> Maybe (NonEmpty Text) -> f (Maybe (NonEmpty Text)))
-> (Maybe (NonEmpty Text) -> f (Maybe (NonEmpty Text)))
-> FilterConfiguration
-> f FilterConfiguration
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso
  (NonEmpty Text) (NonEmpty Text) (NonEmpty Text) (NonEmpty Text)
-> Iso
     (Maybe (NonEmpty Text))
     (Maybe (NonEmpty Text))
     (Maybe (NonEmpty Text))
     (Maybe (NonEmpty Text))
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 AnIso
  (NonEmpty Text) (NonEmpty Text) (NonEmpty Text) (NonEmpty Text)
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Core.FromJSON FilterConfiguration where
  parseJSON :: Value -> Parser FilterConfiguration
parseJSON =
    String
-> (Object -> Parser FilterConfiguration)
-> Value
-> Parser FilterConfiguration
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"FilterConfiguration"
      ( \Object
x ->
          Maybe (NonEmpty Text) -> FilterConfiguration
FilterConfiguration'
            (Maybe (NonEmpty Text) -> FilterConfiguration)
-> Parser (Maybe (NonEmpty Text)) -> Parser FilterConfiguration
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe (NonEmpty Text))
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"AllowedLocations")
      )

instance Prelude.Hashable FilterConfiguration

instance Prelude.NFData FilterConfiguration

instance Core.ToJSON FilterConfiguration where
  toJSON :: FilterConfiguration -> Value
toJSON FilterConfiguration' {Maybe (NonEmpty Text)
allowedLocations :: Maybe (NonEmpty Text)
$sel:allowedLocations:FilterConfiguration' :: FilterConfiguration -> Maybe (NonEmpty Text)
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"AllowedLocations" Text -> NonEmpty Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (NonEmpty Text -> Pair) -> Maybe (NonEmpty Text) -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty Text)
allowedLocations
          ]
      )