{-# 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.FSx.Types.LustreRootSquashConfiguration
-- 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.FSx.Types.LustreRootSquashConfiguration 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

-- | The configuration for Lustre root squash used to restrict root-level
-- access from clients that try to access your FSx for Lustre file system
-- as root. Use the @RootSquash@ parameter to enable root squash. To learn
-- more about Lustre root squash, see
-- <https://docs.aws.amazon.com/fsx/latest/LustreGuide/root-squash.html Lustre root squash>.
--
-- You can also use the @NoSquashNids@ parameter to provide an array of
-- clients who are not affected by the root squash setting. These clients
-- will access the file system as root, with unrestricted privileges.
--
-- /See:/ 'newLustreRootSquashConfiguration' smart constructor.
data LustreRootSquashConfiguration = LustreRootSquashConfiguration'
  { -- | When root squash is enabled, you can optionally specify an array of NIDs
    -- of clients for which root squash does not apply. A client NID is a
    -- Lustre Network Identifier used to uniquely identify a client. You can
    -- specify the NID as either a single address or a range of addresses:
    --
    -- -   A single address is described in standard Lustre NID format by
    --     specifying the client’s IP address followed by the Lustre network ID
    --     (for example, @10.0.1.6\@tcp@).
    --
    -- -   An address range is described using a dash to separate the range
    --     (for example, @10.0.[2-10].[1-255]\@tcp@).
    LustreRootSquashConfiguration -> Maybe [Text]
noSquashNids :: Prelude.Maybe [Prelude.Text],
    -- | You enable root squash by setting a user ID (UID) and group ID (GID) for
    -- the file system in the format @UID:GID@ (for example, @365534:65534@).
    -- The UID and GID values can range from @0@ to @4294967294@:
    --
    -- -   A non-zero value for UID and GID enables root squash. The UID and
    --     GID values can be different, but each must be a non-zero value.
    --
    -- -   A value of @0@ (zero) for UID and GID indicates root, and therefore
    --     disables root squash.
    --
    -- When root squash is enabled, the user ID and group ID of a root user
    -- accessing the file system are re-mapped to the UID and GID you provide.
    LustreRootSquashConfiguration -> Maybe Text
rootSquash :: Prelude.Maybe Prelude.Text
  }
  deriving (LustreRootSquashConfiguration
-> LustreRootSquashConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: LustreRootSquashConfiguration
-> LustreRootSquashConfiguration -> Bool
$c/= :: LustreRootSquashConfiguration
-> LustreRootSquashConfiguration -> Bool
== :: LustreRootSquashConfiguration
-> LustreRootSquashConfiguration -> Bool
$c== :: LustreRootSquashConfiguration
-> LustreRootSquashConfiguration -> Bool
Prelude.Eq, ReadPrec [LustreRootSquashConfiguration]
ReadPrec LustreRootSquashConfiguration
Int -> ReadS LustreRootSquashConfiguration
ReadS [LustreRootSquashConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [LustreRootSquashConfiguration]
$creadListPrec :: ReadPrec [LustreRootSquashConfiguration]
readPrec :: ReadPrec LustreRootSquashConfiguration
$creadPrec :: ReadPrec LustreRootSquashConfiguration
readList :: ReadS [LustreRootSquashConfiguration]
$creadList :: ReadS [LustreRootSquashConfiguration]
readsPrec :: Int -> ReadS LustreRootSquashConfiguration
$creadsPrec :: Int -> ReadS LustreRootSquashConfiguration
Prelude.Read, Int -> LustreRootSquashConfiguration -> ShowS
[LustreRootSquashConfiguration] -> ShowS
LustreRootSquashConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [LustreRootSquashConfiguration] -> ShowS
$cshowList :: [LustreRootSquashConfiguration] -> ShowS
show :: LustreRootSquashConfiguration -> String
$cshow :: LustreRootSquashConfiguration -> String
showsPrec :: Int -> LustreRootSquashConfiguration -> ShowS
$cshowsPrec :: Int -> LustreRootSquashConfiguration -> ShowS
Prelude.Show, forall x.
Rep LustreRootSquashConfiguration x
-> LustreRootSquashConfiguration
forall x.
LustreRootSquashConfiguration
-> Rep LustreRootSquashConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep LustreRootSquashConfiguration x
-> LustreRootSquashConfiguration
$cfrom :: forall x.
LustreRootSquashConfiguration
-> Rep LustreRootSquashConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'LustreRootSquashConfiguration' 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:
--
-- 'noSquashNids', 'lustreRootSquashConfiguration_noSquashNids' - When root squash is enabled, you can optionally specify an array of NIDs
-- of clients for which root squash does not apply. A client NID is a
-- Lustre Network Identifier used to uniquely identify a client. You can
-- specify the NID as either a single address or a range of addresses:
--
-- -   A single address is described in standard Lustre NID format by
--     specifying the client’s IP address followed by the Lustre network ID
--     (for example, @10.0.1.6\@tcp@).
--
-- -   An address range is described using a dash to separate the range
--     (for example, @10.0.[2-10].[1-255]\@tcp@).
--
-- 'rootSquash', 'lustreRootSquashConfiguration_rootSquash' - You enable root squash by setting a user ID (UID) and group ID (GID) for
-- the file system in the format @UID:GID@ (for example, @365534:65534@).
-- The UID and GID values can range from @0@ to @4294967294@:
--
-- -   A non-zero value for UID and GID enables root squash. The UID and
--     GID values can be different, but each must be a non-zero value.
--
-- -   A value of @0@ (zero) for UID and GID indicates root, and therefore
--     disables root squash.
--
-- When root squash is enabled, the user ID and group ID of a root user
-- accessing the file system are re-mapped to the UID and GID you provide.
newLustreRootSquashConfiguration ::
  LustreRootSquashConfiguration
newLustreRootSquashConfiguration :: LustreRootSquashConfiguration
newLustreRootSquashConfiguration =
  LustreRootSquashConfiguration'
    { $sel:noSquashNids:LustreRootSquashConfiguration' :: Maybe [Text]
noSquashNids =
        forall a. Maybe a
Prelude.Nothing,
      $sel:rootSquash:LustreRootSquashConfiguration' :: Maybe Text
rootSquash = forall a. Maybe a
Prelude.Nothing
    }

-- | When root squash is enabled, you can optionally specify an array of NIDs
-- of clients for which root squash does not apply. A client NID is a
-- Lustre Network Identifier used to uniquely identify a client. You can
-- specify the NID as either a single address or a range of addresses:
--
-- -   A single address is described in standard Lustre NID format by
--     specifying the client’s IP address followed by the Lustre network ID
--     (for example, @10.0.1.6\@tcp@).
--
-- -   An address range is described using a dash to separate the range
--     (for example, @10.0.[2-10].[1-255]\@tcp@).
lustreRootSquashConfiguration_noSquashNids :: Lens.Lens' LustreRootSquashConfiguration (Prelude.Maybe [Prelude.Text])
lustreRootSquashConfiguration_noSquashNids :: Lens' LustreRootSquashConfiguration (Maybe [Text])
lustreRootSquashConfiguration_noSquashNids = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LustreRootSquashConfiguration' {Maybe [Text]
noSquashNids :: Maybe [Text]
$sel:noSquashNids:LustreRootSquashConfiguration' :: LustreRootSquashConfiguration -> Maybe [Text]
noSquashNids} -> Maybe [Text]
noSquashNids) (\s :: LustreRootSquashConfiguration
s@LustreRootSquashConfiguration' {} Maybe [Text]
a -> LustreRootSquashConfiguration
s {$sel:noSquashNids:LustreRootSquashConfiguration' :: Maybe [Text]
noSquashNids = Maybe [Text]
a} :: LustreRootSquashConfiguration) 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

-- | You enable root squash by setting a user ID (UID) and group ID (GID) for
-- the file system in the format @UID:GID@ (for example, @365534:65534@).
-- The UID and GID values can range from @0@ to @4294967294@:
--
-- -   A non-zero value for UID and GID enables root squash. The UID and
--     GID values can be different, but each must be a non-zero value.
--
-- -   A value of @0@ (zero) for UID and GID indicates root, and therefore
--     disables root squash.
--
-- When root squash is enabled, the user ID and group ID of a root user
-- accessing the file system are re-mapped to the UID and GID you provide.
lustreRootSquashConfiguration_rootSquash :: Lens.Lens' LustreRootSquashConfiguration (Prelude.Maybe Prelude.Text)
lustreRootSquashConfiguration_rootSquash :: Lens' LustreRootSquashConfiguration (Maybe Text)
lustreRootSquashConfiguration_rootSquash = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\LustreRootSquashConfiguration' {Maybe Text
rootSquash :: Maybe Text
$sel:rootSquash:LustreRootSquashConfiguration' :: LustreRootSquashConfiguration -> Maybe Text
rootSquash} -> Maybe Text
rootSquash) (\s :: LustreRootSquashConfiguration
s@LustreRootSquashConfiguration' {} Maybe Text
a -> LustreRootSquashConfiguration
s {$sel:rootSquash:LustreRootSquashConfiguration' :: Maybe Text
rootSquash = Maybe Text
a} :: LustreRootSquashConfiguration)

instance Data.FromJSON LustreRootSquashConfiguration where
  parseJSON :: Value -> Parser LustreRootSquashConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"LustreRootSquashConfiguration"
      ( \Object
x ->
          Maybe [Text] -> Maybe Text -> LustreRootSquashConfiguration
LustreRootSquashConfiguration'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"NoSquashNids" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"RootSquash")
      )

instance
  Prelude.Hashable
    LustreRootSquashConfiguration
  where
  hashWithSalt :: Int -> LustreRootSquashConfiguration -> Int
hashWithSalt Int
_salt LustreRootSquashConfiguration' {Maybe [Text]
Maybe Text
rootSquash :: Maybe Text
noSquashNids :: Maybe [Text]
$sel:rootSquash:LustreRootSquashConfiguration' :: LustreRootSquashConfiguration -> Maybe Text
$sel:noSquashNids:LustreRootSquashConfiguration' :: LustreRootSquashConfiguration -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
noSquashNids
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
rootSquash

instance Prelude.NFData LustreRootSquashConfiguration where
  rnf :: LustreRootSquashConfiguration -> ()
rnf LustreRootSquashConfiguration' {Maybe [Text]
Maybe Text
rootSquash :: Maybe Text
noSquashNids :: Maybe [Text]
$sel:rootSquash:LustreRootSquashConfiguration' :: LustreRootSquashConfiguration -> Maybe Text
$sel:noSquashNids:LustreRootSquashConfiguration' :: LustreRootSquashConfiguration -> Maybe [Text]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
noSquashNids
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
rootSquash

instance Data.ToJSON LustreRootSquashConfiguration where
  toJSON :: LustreRootSquashConfiguration -> Value
toJSON LustreRootSquashConfiguration' {Maybe [Text]
Maybe Text
rootSquash :: Maybe Text
noSquashNids :: Maybe [Text]
$sel:rootSquash:LustreRootSquashConfiguration' :: LustreRootSquashConfiguration -> Maybe Text
$sel:noSquashNids:LustreRootSquashConfiguration' :: LustreRootSquashConfiguration -> Maybe [Text]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"NoSquashNids" 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 [Text]
noSquashNids,
            (Key
"RootSquash" 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 Text
rootSquash
          ]
      )