{-# 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.SSM.Types.DocumentParameter
-- 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.SSM.Types.DocumentParameter 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.SSM.Types.DocumentParameterType

-- | Parameters specified in a System Manager document that run on the server
-- when the command is run.
--
-- /See:/ 'newDocumentParameter' smart constructor.
data DocumentParameter = DocumentParameter'
  { -- | If specified, the default values for the parameters. Parameters without
    -- a default value are required. Parameters with a default value are
    -- optional.
    DocumentParameter -> Maybe Text
defaultValue :: Prelude.Maybe Prelude.Text,
    -- | A description of what the parameter does, how to use it, the default
    -- value, and whether or not the parameter is optional.
    DocumentParameter -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | The name of the parameter.
    DocumentParameter -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The type of parameter. The type can be either String or StringList.
    DocumentParameter -> Maybe DocumentParameterType
type' :: Prelude.Maybe DocumentParameterType
  }
  deriving (DocumentParameter -> DocumentParameter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DocumentParameter -> DocumentParameter -> Bool
$c/= :: DocumentParameter -> DocumentParameter -> Bool
== :: DocumentParameter -> DocumentParameter -> Bool
$c== :: DocumentParameter -> DocumentParameter -> Bool
Prelude.Eq, ReadPrec [DocumentParameter]
ReadPrec DocumentParameter
Int -> ReadS DocumentParameter
ReadS [DocumentParameter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DocumentParameter]
$creadListPrec :: ReadPrec [DocumentParameter]
readPrec :: ReadPrec DocumentParameter
$creadPrec :: ReadPrec DocumentParameter
readList :: ReadS [DocumentParameter]
$creadList :: ReadS [DocumentParameter]
readsPrec :: Int -> ReadS DocumentParameter
$creadsPrec :: Int -> ReadS DocumentParameter
Prelude.Read, Int -> DocumentParameter -> ShowS
[DocumentParameter] -> ShowS
DocumentParameter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DocumentParameter] -> ShowS
$cshowList :: [DocumentParameter] -> ShowS
show :: DocumentParameter -> String
$cshow :: DocumentParameter -> String
showsPrec :: Int -> DocumentParameter -> ShowS
$cshowsPrec :: Int -> DocumentParameter -> ShowS
Prelude.Show, forall x. Rep DocumentParameter x -> DocumentParameter
forall x. DocumentParameter -> Rep DocumentParameter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DocumentParameter x -> DocumentParameter
$cfrom :: forall x. DocumentParameter -> Rep DocumentParameter x
Prelude.Generic)

-- |
-- Create a value of 'DocumentParameter' 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:
--
-- 'defaultValue', 'documentParameter_defaultValue' - If specified, the default values for the parameters. Parameters without
-- a default value are required. Parameters with a default value are
-- optional.
--
-- 'description', 'documentParameter_description' - A description of what the parameter does, how to use it, the default
-- value, and whether or not the parameter is optional.
--
-- 'name', 'documentParameter_name' - The name of the parameter.
--
-- 'type'', 'documentParameter_type' - The type of parameter. The type can be either String or StringList.
newDocumentParameter ::
  DocumentParameter
newDocumentParameter :: DocumentParameter
newDocumentParameter =
  DocumentParameter'
    { $sel:defaultValue:DocumentParameter' :: Maybe Text
defaultValue = forall a. Maybe a
Prelude.Nothing,
      $sel:description:DocumentParameter' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:name:DocumentParameter' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:type':DocumentParameter' :: Maybe DocumentParameterType
type' = forall a. Maybe a
Prelude.Nothing
    }

-- | If specified, the default values for the parameters. Parameters without
-- a default value are required. Parameters with a default value are
-- optional.
documentParameter_defaultValue :: Lens.Lens' DocumentParameter (Prelude.Maybe Prelude.Text)
documentParameter_defaultValue :: Lens' DocumentParameter (Maybe Text)
documentParameter_defaultValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentParameter' {Maybe Text
defaultValue :: Maybe Text
$sel:defaultValue:DocumentParameter' :: DocumentParameter -> Maybe Text
defaultValue} -> Maybe Text
defaultValue) (\s :: DocumentParameter
s@DocumentParameter' {} Maybe Text
a -> DocumentParameter
s {$sel:defaultValue:DocumentParameter' :: Maybe Text
defaultValue = Maybe Text
a} :: DocumentParameter)

-- | A description of what the parameter does, how to use it, the default
-- value, and whether or not the parameter is optional.
documentParameter_description :: Lens.Lens' DocumentParameter (Prelude.Maybe Prelude.Text)
documentParameter_description :: Lens' DocumentParameter (Maybe Text)
documentParameter_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentParameter' {Maybe Text
description :: Maybe Text
$sel:description:DocumentParameter' :: DocumentParameter -> Maybe Text
description} -> Maybe Text
description) (\s :: DocumentParameter
s@DocumentParameter' {} Maybe Text
a -> DocumentParameter
s {$sel:description:DocumentParameter' :: Maybe Text
description = Maybe Text
a} :: DocumentParameter)

-- | The name of the parameter.
documentParameter_name :: Lens.Lens' DocumentParameter (Prelude.Maybe Prelude.Text)
documentParameter_name :: Lens' DocumentParameter (Maybe Text)
documentParameter_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentParameter' {Maybe Text
name :: Maybe Text
$sel:name:DocumentParameter' :: DocumentParameter -> Maybe Text
name} -> Maybe Text
name) (\s :: DocumentParameter
s@DocumentParameter' {} Maybe Text
a -> DocumentParameter
s {$sel:name:DocumentParameter' :: Maybe Text
name = Maybe Text
a} :: DocumentParameter)

-- | The type of parameter. The type can be either String or StringList.
documentParameter_type :: Lens.Lens' DocumentParameter (Prelude.Maybe DocumentParameterType)
documentParameter_type :: Lens' DocumentParameter (Maybe DocumentParameterType)
documentParameter_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentParameter' {Maybe DocumentParameterType
type' :: Maybe DocumentParameterType
$sel:type':DocumentParameter' :: DocumentParameter -> Maybe DocumentParameterType
type'} -> Maybe DocumentParameterType
type') (\s :: DocumentParameter
s@DocumentParameter' {} Maybe DocumentParameterType
a -> DocumentParameter
s {$sel:type':DocumentParameter' :: Maybe DocumentParameterType
type' = Maybe DocumentParameterType
a} :: DocumentParameter)

instance Data.FromJSON DocumentParameter where
  parseJSON :: Value -> Parser DocumentParameter
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DocumentParameter"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe DocumentParameterType
-> DocumentParameter
DocumentParameter'
            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
"DefaultValue")
            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
"Description")
            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
"Name")
            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
"Type")
      )

instance Prelude.Hashable DocumentParameter where
  hashWithSalt :: Int -> DocumentParameter -> Int
hashWithSalt Int
_salt DocumentParameter' {Maybe Text
Maybe DocumentParameterType
type' :: Maybe DocumentParameterType
name :: Maybe Text
description :: Maybe Text
defaultValue :: Maybe Text
$sel:type':DocumentParameter' :: DocumentParameter -> Maybe DocumentParameterType
$sel:name:DocumentParameter' :: DocumentParameter -> Maybe Text
$sel:description:DocumentParameter' :: DocumentParameter -> Maybe Text
$sel:defaultValue:DocumentParameter' :: DocumentParameter -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
defaultValue
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DocumentParameterType
type'

instance Prelude.NFData DocumentParameter where
  rnf :: DocumentParameter -> ()
rnf DocumentParameter' {Maybe Text
Maybe DocumentParameterType
type' :: Maybe DocumentParameterType
name :: Maybe Text
description :: Maybe Text
defaultValue :: Maybe Text
$sel:type':DocumentParameter' :: DocumentParameter -> Maybe DocumentParameterType
$sel:name:DocumentParameter' :: DocumentParameter -> Maybe Text
$sel:description:DocumentParameter' :: DocumentParameter -> Maybe Text
$sel:defaultValue:DocumentParameter' :: DocumentParameter -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
defaultValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DocumentParameterType
type'