{-# 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.CertificateManager.Types.Filters
-- 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.CertificateManager.Types.Filters where

import Amazonka.CertificateManager.Types.ExtendedKeyUsageName
import Amazonka.CertificateManager.Types.KeyAlgorithm
import Amazonka.CertificateManager.Types.KeyUsageName
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

-- | This structure can be used in the ListCertificates action to filter the
-- output of the certificate list.
--
-- /See:/ 'newFilters' smart constructor.
data Filters = Filters'
  { -- | Specify one or more ExtendedKeyUsage extension values.
    Filters -> Maybe [ExtendedKeyUsageName]
extendedKeyUsage :: Prelude.Maybe [ExtendedKeyUsageName],
    -- | Specify one or more algorithms that can be used to generate key pairs.
    --
    -- Default filtering returns only @RSA_1024@ and @RSA_2048@ certificates
    -- that have at least one domain. To return other certificate types,
    -- provide the desired type signatures in a comma-separated list. For
    -- example, @\"keyTypes\": [\"RSA_2048\",\"RSA_4096\"]@ returns both
    -- @RSA_2048@ and @RSA_4096@ certificates.
    Filters -> Maybe [KeyAlgorithm]
keyTypes :: Prelude.Maybe [KeyAlgorithm],
    -- | Specify one or more KeyUsage extension values.
    Filters -> Maybe [KeyUsageName]
keyUsage :: Prelude.Maybe [KeyUsageName]
  }
  deriving (Filters -> Filters -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Filters -> Filters -> Bool
$c/= :: Filters -> Filters -> Bool
== :: Filters -> Filters -> Bool
$c== :: Filters -> Filters -> Bool
Prelude.Eq, ReadPrec [Filters]
ReadPrec Filters
Int -> ReadS Filters
ReadS [Filters]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Filters]
$creadListPrec :: ReadPrec [Filters]
readPrec :: ReadPrec Filters
$creadPrec :: ReadPrec Filters
readList :: ReadS [Filters]
$creadList :: ReadS [Filters]
readsPrec :: Int -> ReadS Filters
$creadsPrec :: Int -> ReadS Filters
Prelude.Read, Int -> Filters -> ShowS
[Filters] -> ShowS
Filters -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Filters] -> ShowS
$cshowList :: [Filters] -> ShowS
show :: Filters -> String
$cshow :: Filters -> String
showsPrec :: Int -> Filters -> ShowS
$cshowsPrec :: Int -> Filters -> ShowS
Prelude.Show, forall x. Rep Filters x -> Filters
forall x. Filters -> Rep Filters x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Filters x -> Filters
$cfrom :: forall x. Filters -> Rep Filters x
Prelude.Generic)

-- |
-- Create a value of 'Filters' 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:
--
-- 'extendedKeyUsage', 'filters_extendedKeyUsage' - Specify one or more ExtendedKeyUsage extension values.
--
-- 'keyTypes', 'filters_keyTypes' - Specify one or more algorithms that can be used to generate key pairs.
--
-- Default filtering returns only @RSA_1024@ and @RSA_2048@ certificates
-- that have at least one domain. To return other certificate types,
-- provide the desired type signatures in a comma-separated list. For
-- example, @\"keyTypes\": [\"RSA_2048\",\"RSA_4096\"]@ returns both
-- @RSA_2048@ and @RSA_4096@ certificates.
--
-- 'keyUsage', 'filters_keyUsage' - Specify one or more KeyUsage extension values.
newFilters ::
  Filters
newFilters :: Filters
newFilters =
  Filters'
    { $sel:extendedKeyUsage:Filters' :: Maybe [ExtendedKeyUsageName]
extendedKeyUsage = forall a. Maybe a
Prelude.Nothing,
      $sel:keyTypes:Filters' :: Maybe [KeyAlgorithm]
keyTypes = forall a. Maybe a
Prelude.Nothing,
      $sel:keyUsage:Filters' :: Maybe [KeyUsageName]
keyUsage = forall a. Maybe a
Prelude.Nothing
    }

-- | Specify one or more ExtendedKeyUsage extension values.
filters_extendedKeyUsage :: Lens.Lens' Filters (Prelude.Maybe [ExtendedKeyUsageName])
filters_extendedKeyUsage :: Lens' Filters (Maybe [ExtendedKeyUsageName])
filters_extendedKeyUsage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filters' {Maybe [ExtendedKeyUsageName]
extendedKeyUsage :: Maybe [ExtendedKeyUsageName]
$sel:extendedKeyUsage:Filters' :: Filters -> Maybe [ExtendedKeyUsageName]
extendedKeyUsage} -> Maybe [ExtendedKeyUsageName]
extendedKeyUsage) (\s :: Filters
s@Filters' {} Maybe [ExtendedKeyUsageName]
a -> Filters
s {$sel:extendedKeyUsage:Filters' :: Maybe [ExtendedKeyUsageName]
extendedKeyUsage = Maybe [ExtendedKeyUsageName]
a} :: Filters) 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

-- | Specify one or more algorithms that can be used to generate key pairs.
--
-- Default filtering returns only @RSA_1024@ and @RSA_2048@ certificates
-- that have at least one domain. To return other certificate types,
-- provide the desired type signatures in a comma-separated list. For
-- example, @\"keyTypes\": [\"RSA_2048\",\"RSA_4096\"]@ returns both
-- @RSA_2048@ and @RSA_4096@ certificates.
filters_keyTypes :: Lens.Lens' Filters (Prelude.Maybe [KeyAlgorithm])
filters_keyTypes :: Lens' Filters (Maybe [KeyAlgorithm])
filters_keyTypes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filters' {Maybe [KeyAlgorithm]
keyTypes :: Maybe [KeyAlgorithm]
$sel:keyTypes:Filters' :: Filters -> Maybe [KeyAlgorithm]
keyTypes} -> Maybe [KeyAlgorithm]
keyTypes) (\s :: Filters
s@Filters' {} Maybe [KeyAlgorithm]
a -> Filters
s {$sel:keyTypes:Filters' :: Maybe [KeyAlgorithm]
keyTypes = Maybe [KeyAlgorithm]
a} :: Filters) 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

-- | Specify one or more KeyUsage extension values.
filters_keyUsage :: Lens.Lens' Filters (Prelude.Maybe [KeyUsageName])
filters_keyUsage :: Lens' Filters (Maybe [KeyUsageName])
filters_keyUsage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filters' {Maybe [KeyUsageName]
keyUsage :: Maybe [KeyUsageName]
$sel:keyUsage:Filters' :: Filters -> Maybe [KeyUsageName]
keyUsage} -> Maybe [KeyUsageName]
keyUsage) (\s :: Filters
s@Filters' {} Maybe [KeyUsageName]
a -> Filters
s {$sel:keyUsage:Filters' :: Maybe [KeyUsageName]
keyUsage = Maybe [KeyUsageName]
a} :: Filters) 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 Filters where
  hashWithSalt :: Int -> Filters -> Int
hashWithSalt Int
_salt Filters' {Maybe [ExtendedKeyUsageName]
Maybe [KeyAlgorithm]
Maybe [KeyUsageName]
keyUsage :: Maybe [KeyUsageName]
keyTypes :: Maybe [KeyAlgorithm]
extendedKeyUsage :: Maybe [ExtendedKeyUsageName]
$sel:keyUsage:Filters' :: Filters -> Maybe [KeyUsageName]
$sel:keyTypes:Filters' :: Filters -> Maybe [KeyAlgorithm]
$sel:extendedKeyUsage:Filters' :: Filters -> Maybe [ExtendedKeyUsageName]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [ExtendedKeyUsageName]
extendedKeyUsage
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [KeyAlgorithm]
keyTypes
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [KeyUsageName]
keyUsage

instance Prelude.NFData Filters where
  rnf :: Filters -> ()
rnf Filters' {Maybe [ExtendedKeyUsageName]
Maybe [KeyAlgorithm]
Maybe [KeyUsageName]
keyUsage :: Maybe [KeyUsageName]
keyTypes :: Maybe [KeyAlgorithm]
extendedKeyUsage :: Maybe [ExtendedKeyUsageName]
$sel:keyUsage:Filters' :: Filters -> Maybe [KeyUsageName]
$sel:keyTypes:Filters' :: Filters -> Maybe [KeyAlgorithm]
$sel:extendedKeyUsage:Filters' :: Filters -> Maybe [ExtendedKeyUsageName]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [ExtendedKeyUsageName]
extendedKeyUsage
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [KeyAlgorithm]
keyTypes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [KeyUsageName]
keyUsage

instance Data.ToJSON Filters where
  toJSON :: Filters -> Value
toJSON Filters' {Maybe [ExtendedKeyUsageName]
Maybe [KeyAlgorithm]
Maybe [KeyUsageName]
keyUsage :: Maybe [KeyUsageName]
keyTypes :: Maybe [KeyAlgorithm]
extendedKeyUsage :: Maybe [ExtendedKeyUsageName]
$sel:keyUsage:Filters' :: Filters -> Maybe [KeyUsageName]
$sel:keyTypes:Filters' :: Filters -> Maybe [KeyAlgorithm]
$sel:extendedKeyUsage:Filters' :: Filters -> Maybe [ExtendedKeyUsageName]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"extendedKeyUsage" 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 [ExtendedKeyUsageName]
extendedKeyUsage,
            (Key
"keyTypes" 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 [KeyAlgorithm]
keyTypes,
            (Key
"keyUsage" 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 [KeyUsageName]
keyUsage
          ]
      )