{-# 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.Shield.Types.InclusionProtectionGroupFilters
-- 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.Shield.Types.InclusionProtectionGroupFilters 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
import Amazonka.Shield.Types.ProtectedResourceType
import Amazonka.Shield.Types.ProtectionGroupAggregation
import Amazonka.Shield.Types.ProtectionGroupPattern

-- | Narrows the set of protection groups that the call retrieves. You can
-- retrieve a single protection group by its name and you can retrieve all
-- protection groups that are configured with a specific pattern,
-- aggregation, or resource type. You can provide up to one criteria per
-- filter type. Shield Advanced returns the protection groups that exactly
-- match all of the search criteria that you provide.
--
-- /See:/ 'newInclusionProtectionGroupFilters' smart constructor.
data InclusionProtectionGroupFilters = InclusionProtectionGroupFilters'
  { -- | The aggregation setting of the protection groups that you want to
    -- retrieve.
    InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupAggregation)
aggregations :: Prelude.Maybe (Prelude.NonEmpty ProtectionGroupAggregation),
    -- | The pattern specification of the protection groups that you want to
    -- retrieve.
    InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupPattern)
patterns :: Prelude.Maybe (Prelude.NonEmpty ProtectionGroupPattern),
    -- | The ID of the protection group that you want to retrieve.
    InclusionProtectionGroupFilters -> Maybe (NonEmpty Text)
protectionGroupIds :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text),
    -- | The resource type configuration of the protection groups that you want
    -- to retrieve. In the protection group configuration, you specify the
    -- resource type when you set the group\'s @Pattern@ to @BY_RESOURCE_TYPE@.
    InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectedResourceType)
resourceTypes :: Prelude.Maybe (Prelude.NonEmpty ProtectedResourceType)
  }
  deriving (InclusionProtectionGroupFilters
-> InclusionProtectionGroupFilters -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: InclusionProtectionGroupFilters
-> InclusionProtectionGroupFilters -> Bool
$c/= :: InclusionProtectionGroupFilters
-> InclusionProtectionGroupFilters -> Bool
== :: InclusionProtectionGroupFilters
-> InclusionProtectionGroupFilters -> Bool
$c== :: InclusionProtectionGroupFilters
-> InclusionProtectionGroupFilters -> Bool
Prelude.Eq, ReadPrec [InclusionProtectionGroupFilters]
ReadPrec InclusionProtectionGroupFilters
Int -> ReadS InclusionProtectionGroupFilters
ReadS [InclusionProtectionGroupFilters]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [InclusionProtectionGroupFilters]
$creadListPrec :: ReadPrec [InclusionProtectionGroupFilters]
readPrec :: ReadPrec InclusionProtectionGroupFilters
$creadPrec :: ReadPrec InclusionProtectionGroupFilters
readList :: ReadS [InclusionProtectionGroupFilters]
$creadList :: ReadS [InclusionProtectionGroupFilters]
readsPrec :: Int -> ReadS InclusionProtectionGroupFilters
$creadsPrec :: Int -> ReadS InclusionProtectionGroupFilters
Prelude.Read, Int -> InclusionProtectionGroupFilters -> ShowS
[InclusionProtectionGroupFilters] -> ShowS
InclusionProtectionGroupFilters -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [InclusionProtectionGroupFilters] -> ShowS
$cshowList :: [InclusionProtectionGroupFilters] -> ShowS
show :: InclusionProtectionGroupFilters -> String
$cshow :: InclusionProtectionGroupFilters -> String
showsPrec :: Int -> InclusionProtectionGroupFilters -> ShowS
$cshowsPrec :: Int -> InclusionProtectionGroupFilters -> ShowS
Prelude.Show, forall x.
Rep InclusionProtectionGroupFilters x
-> InclusionProtectionGroupFilters
forall x.
InclusionProtectionGroupFilters
-> Rep InclusionProtectionGroupFilters x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep InclusionProtectionGroupFilters x
-> InclusionProtectionGroupFilters
$cfrom :: forall x.
InclusionProtectionGroupFilters
-> Rep InclusionProtectionGroupFilters x
Prelude.Generic)

-- |
-- Create a value of 'InclusionProtectionGroupFilters' 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:
--
-- 'aggregations', 'inclusionProtectionGroupFilters_aggregations' - The aggregation setting of the protection groups that you want to
-- retrieve.
--
-- 'patterns', 'inclusionProtectionGroupFilters_patterns' - The pattern specification of the protection groups that you want to
-- retrieve.
--
-- 'protectionGroupIds', 'inclusionProtectionGroupFilters_protectionGroupIds' - The ID of the protection group that you want to retrieve.
--
-- 'resourceTypes', 'inclusionProtectionGroupFilters_resourceTypes' - The resource type configuration of the protection groups that you want
-- to retrieve. In the protection group configuration, you specify the
-- resource type when you set the group\'s @Pattern@ to @BY_RESOURCE_TYPE@.
newInclusionProtectionGroupFilters ::
  InclusionProtectionGroupFilters
newInclusionProtectionGroupFilters :: InclusionProtectionGroupFilters
newInclusionProtectionGroupFilters =
  InclusionProtectionGroupFilters'
    { $sel:aggregations:InclusionProtectionGroupFilters' :: Maybe (NonEmpty ProtectionGroupAggregation)
aggregations =
        forall a. Maybe a
Prelude.Nothing,
      $sel:patterns:InclusionProtectionGroupFilters' :: Maybe (NonEmpty ProtectionGroupPattern)
patterns = forall a. Maybe a
Prelude.Nothing,
      $sel:protectionGroupIds:InclusionProtectionGroupFilters' :: Maybe (NonEmpty Text)
protectionGroupIds = forall a. Maybe a
Prelude.Nothing,
      $sel:resourceTypes:InclusionProtectionGroupFilters' :: Maybe (NonEmpty ProtectedResourceType)
resourceTypes = forall a. Maybe a
Prelude.Nothing
    }

-- | The aggregation setting of the protection groups that you want to
-- retrieve.
inclusionProtectionGroupFilters_aggregations :: Lens.Lens' InclusionProtectionGroupFilters (Prelude.Maybe (Prelude.NonEmpty ProtectionGroupAggregation))
inclusionProtectionGroupFilters_aggregations :: Lens'
  InclusionProtectionGroupFilters
  (Maybe (NonEmpty ProtectionGroupAggregation))
inclusionProtectionGroupFilters_aggregations = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InclusionProtectionGroupFilters' {Maybe (NonEmpty ProtectionGroupAggregation)
aggregations :: Maybe (NonEmpty ProtectionGroupAggregation)
$sel:aggregations:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupAggregation)
aggregations} -> Maybe (NonEmpty ProtectionGroupAggregation)
aggregations) (\s :: InclusionProtectionGroupFilters
s@InclusionProtectionGroupFilters' {} Maybe (NonEmpty ProtectionGroupAggregation)
a -> InclusionProtectionGroupFilters
s {$sel:aggregations:InclusionProtectionGroupFilters' :: Maybe (NonEmpty ProtectionGroupAggregation)
aggregations = Maybe (NonEmpty ProtectionGroupAggregation)
a} :: InclusionProtectionGroupFilters) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The pattern specification of the protection groups that you want to
-- retrieve.
inclusionProtectionGroupFilters_patterns :: Lens.Lens' InclusionProtectionGroupFilters (Prelude.Maybe (Prelude.NonEmpty ProtectionGroupPattern))
inclusionProtectionGroupFilters_patterns :: Lens'
  InclusionProtectionGroupFilters
  (Maybe (NonEmpty ProtectionGroupPattern))
inclusionProtectionGroupFilters_patterns = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InclusionProtectionGroupFilters' {Maybe (NonEmpty ProtectionGroupPattern)
patterns :: Maybe (NonEmpty ProtectionGroupPattern)
$sel:patterns:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupPattern)
patterns} -> Maybe (NonEmpty ProtectionGroupPattern)
patterns) (\s :: InclusionProtectionGroupFilters
s@InclusionProtectionGroupFilters' {} Maybe (NonEmpty ProtectionGroupPattern)
a -> InclusionProtectionGroupFilters
s {$sel:patterns:InclusionProtectionGroupFilters' :: Maybe (NonEmpty ProtectionGroupPattern)
patterns = Maybe (NonEmpty ProtectionGroupPattern)
a} :: InclusionProtectionGroupFilters) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The ID of the protection group that you want to retrieve.
inclusionProtectionGroupFilters_protectionGroupIds :: Lens.Lens' InclusionProtectionGroupFilters (Prelude.Maybe (Prelude.NonEmpty Prelude.Text))
inclusionProtectionGroupFilters_protectionGroupIds :: Lens' InclusionProtectionGroupFilters (Maybe (NonEmpty Text))
inclusionProtectionGroupFilters_protectionGroupIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InclusionProtectionGroupFilters' {Maybe (NonEmpty Text)
protectionGroupIds :: Maybe (NonEmpty Text)
$sel:protectionGroupIds:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters -> Maybe (NonEmpty Text)
protectionGroupIds} -> Maybe (NonEmpty Text)
protectionGroupIds) (\s :: InclusionProtectionGroupFilters
s@InclusionProtectionGroupFilters' {} Maybe (NonEmpty Text)
a -> InclusionProtectionGroupFilters
s {$sel:protectionGroupIds:InclusionProtectionGroupFilters' :: Maybe (NonEmpty Text)
protectionGroupIds = Maybe (NonEmpty Text)
a} :: InclusionProtectionGroupFilters) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The resource type configuration of the protection groups that you want
-- to retrieve. In the protection group configuration, you specify the
-- resource type when you set the group\'s @Pattern@ to @BY_RESOURCE_TYPE@.
inclusionProtectionGroupFilters_resourceTypes :: Lens.Lens' InclusionProtectionGroupFilters (Prelude.Maybe (Prelude.NonEmpty ProtectedResourceType))
inclusionProtectionGroupFilters_resourceTypes :: Lens'
  InclusionProtectionGroupFilters
  (Maybe (NonEmpty ProtectedResourceType))
inclusionProtectionGroupFilters_resourceTypes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InclusionProtectionGroupFilters' {Maybe (NonEmpty ProtectedResourceType)
resourceTypes :: Maybe (NonEmpty ProtectedResourceType)
$sel:resourceTypes:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectedResourceType)
resourceTypes} -> Maybe (NonEmpty ProtectedResourceType)
resourceTypes) (\s :: InclusionProtectionGroupFilters
s@InclusionProtectionGroupFilters' {} Maybe (NonEmpty ProtectedResourceType)
a -> InclusionProtectionGroupFilters
s {$sel:resourceTypes:InclusionProtectionGroupFilters' :: Maybe (NonEmpty ProtectedResourceType)
resourceTypes = Maybe (NonEmpty ProtectedResourceType)
a} :: InclusionProtectionGroupFilters) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance
  Prelude.Hashable
    InclusionProtectionGroupFilters
  where
  hashWithSalt :: Int -> InclusionProtectionGroupFilters -> Int
hashWithSalt
    Int
_salt
    InclusionProtectionGroupFilters' {Maybe (NonEmpty Text)
Maybe (NonEmpty ProtectedResourceType)
Maybe (NonEmpty ProtectionGroupAggregation)
Maybe (NonEmpty ProtectionGroupPattern)
resourceTypes :: Maybe (NonEmpty ProtectedResourceType)
protectionGroupIds :: Maybe (NonEmpty Text)
patterns :: Maybe (NonEmpty ProtectionGroupPattern)
aggregations :: Maybe (NonEmpty ProtectionGroupAggregation)
$sel:resourceTypes:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectedResourceType)
$sel:protectionGroupIds:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters -> Maybe (NonEmpty Text)
$sel:patterns:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupPattern)
$sel:aggregations:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupAggregation)
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty ProtectionGroupAggregation)
aggregations
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty ProtectionGroupPattern)
patterns
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty Text)
protectionGroupIds
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty ProtectedResourceType)
resourceTypes

instance
  Prelude.NFData
    InclusionProtectionGroupFilters
  where
  rnf :: InclusionProtectionGroupFilters -> ()
rnf InclusionProtectionGroupFilters' {Maybe (NonEmpty Text)
Maybe (NonEmpty ProtectedResourceType)
Maybe (NonEmpty ProtectionGroupAggregation)
Maybe (NonEmpty ProtectionGroupPattern)
resourceTypes :: Maybe (NonEmpty ProtectedResourceType)
protectionGroupIds :: Maybe (NonEmpty Text)
patterns :: Maybe (NonEmpty ProtectionGroupPattern)
aggregations :: Maybe (NonEmpty ProtectionGroupAggregation)
$sel:resourceTypes:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectedResourceType)
$sel:protectionGroupIds:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters -> Maybe (NonEmpty Text)
$sel:patterns:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupPattern)
$sel:aggregations:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupAggregation)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty ProtectionGroupAggregation)
aggregations
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty ProtectionGroupPattern)
patterns
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty Text)
protectionGroupIds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty ProtectedResourceType)
resourceTypes

instance Data.ToJSON InclusionProtectionGroupFilters where
  toJSON :: InclusionProtectionGroupFilters -> Value
toJSON InclusionProtectionGroupFilters' {Maybe (NonEmpty Text)
Maybe (NonEmpty ProtectedResourceType)
Maybe (NonEmpty ProtectionGroupAggregation)
Maybe (NonEmpty ProtectionGroupPattern)
resourceTypes :: Maybe (NonEmpty ProtectedResourceType)
protectionGroupIds :: Maybe (NonEmpty Text)
patterns :: Maybe (NonEmpty ProtectionGroupPattern)
aggregations :: Maybe (NonEmpty ProtectionGroupAggregation)
$sel:resourceTypes:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectedResourceType)
$sel:protectionGroupIds:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters -> Maybe (NonEmpty Text)
$sel:patterns:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupPattern)
$sel:aggregations:InclusionProtectionGroupFilters' :: InclusionProtectionGroupFilters
-> Maybe (NonEmpty ProtectionGroupAggregation)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Aggregations" 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 (NonEmpty ProtectionGroupAggregation)
aggregations,
            (Key
"Patterns" 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 (NonEmpty ProtectionGroupPattern)
patterns,
            (Key
"ProtectionGroupIds" 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 (NonEmpty Text)
protectionGroupIds,
            (Key
"ResourceTypes" 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 (NonEmpty ProtectedResourceType)
resourceTypes
          ]
      )