{-# 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.Parameter
-- 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.Parameter 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.ParameterType

-- | An Amazon Web Services Systems Manager parameter in Parameter Store.
--
-- /See:/ 'newParameter' smart constructor.
data Parameter = Parameter'
  { -- | The Amazon Resource Name (ARN) of the parameter.
    Parameter -> Maybe Text
arn :: Prelude.Maybe Prelude.Text,
    -- | The data type of the parameter, such as @text@ or @aws:ec2:image@. The
    -- default is @text@.
    Parameter -> Maybe Text
dataType :: Prelude.Maybe Prelude.Text,
    -- | Date the parameter was last changed or updated and the parameter version
    -- was created.
    Parameter -> Maybe POSIX
lastModifiedDate :: Prelude.Maybe Data.POSIX,
    -- | Either the version number or the label used to retrieve the parameter
    -- value. Specify selectors by using one of the following formats:
    --
    -- parameter_name:version
    --
    -- parameter_name:label
    Parameter -> Maybe Text
selector :: Prelude.Maybe Prelude.Text,
    -- | Applies to parameters that reference information in other Amazon Web
    -- Services services. @SourceResult@ is the raw result or response from the
    -- source.
    Parameter -> Maybe Text
sourceResult :: Prelude.Maybe Prelude.Text,
    -- | The name of the parameter.
    Parameter -> Text
name :: Prelude.Text,
    -- | The type of parameter. Valid values include the following: @String@,
    -- @StringList@, and @SecureString@.
    --
    -- If type is @StringList@, the system returns a comma-separated string
    -- with no spaces between commas in the @Value@ field.
    Parameter -> ParameterType
type' :: ParameterType,
    -- | The parameter value.
    --
    -- If type is @StringList@, the system returns a comma-separated string
    -- with no spaces between commas in the @Value@ field.
    Parameter -> Sensitive Text
value :: Data.Sensitive Prelude.Text,
    -- | The parameter version.
    Parameter -> Integer
version :: Prelude.Integer
  }
  deriving (Parameter -> Parameter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Parameter -> Parameter -> Bool
$c/= :: Parameter -> Parameter -> Bool
== :: Parameter -> Parameter -> Bool
$c== :: Parameter -> Parameter -> Bool
Prelude.Eq, Int -> Parameter -> ShowS
[Parameter] -> ShowS
Parameter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Parameter] -> ShowS
$cshowList :: [Parameter] -> ShowS
show :: Parameter -> String
$cshow :: Parameter -> String
showsPrec :: Int -> Parameter -> ShowS
$cshowsPrec :: Int -> Parameter -> ShowS
Prelude.Show, forall x. Rep Parameter x -> Parameter
forall x. Parameter -> Rep Parameter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Parameter x -> Parameter
$cfrom :: forall x. Parameter -> Rep Parameter x
Prelude.Generic)

-- |
-- Create a value of 'Parameter' 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:
--
-- 'arn', 'parameter_arn' - The Amazon Resource Name (ARN) of the parameter.
--
-- 'dataType', 'parameter_dataType' - The data type of the parameter, such as @text@ or @aws:ec2:image@. The
-- default is @text@.
--
-- 'lastModifiedDate', 'parameter_lastModifiedDate' - Date the parameter was last changed or updated and the parameter version
-- was created.
--
-- 'selector', 'parameter_selector' - Either the version number or the label used to retrieve the parameter
-- value. Specify selectors by using one of the following formats:
--
-- parameter_name:version
--
-- parameter_name:label
--
-- 'sourceResult', 'parameter_sourceResult' - Applies to parameters that reference information in other Amazon Web
-- Services services. @SourceResult@ is the raw result or response from the
-- source.
--
-- 'name', 'parameter_name' - The name of the parameter.
--
-- 'type'', 'parameter_type' - The type of parameter. Valid values include the following: @String@,
-- @StringList@, and @SecureString@.
--
-- If type is @StringList@, the system returns a comma-separated string
-- with no spaces between commas in the @Value@ field.
--
-- 'value', 'parameter_value' - The parameter value.
--
-- If type is @StringList@, the system returns a comma-separated string
-- with no spaces between commas in the @Value@ field.
--
-- 'version', 'parameter_version' - The parameter version.
newParameter ::
  -- | 'name'
  Prelude.Text ->
  -- | 'type''
  ParameterType ->
  -- | 'value'
  Prelude.Text ->
  -- | 'version'
  Prelude.Integer ->
  Parameter
newParameter :: Text -> ParameterType -> Text -> Integer -> Parameter
newParameter Text
pName_ ParameterType
pType_ Text
pValue_ Integer
pVersion_ =
  Parameter'
    { $sel:arn:Parameter' :: Maybe Text
arn = forall a. Maybe a
Prelude.Nothing,
      $sel:dataType:Parameter' :: Maybe Text
dataType = forall a. Maybe a
Prelude.Nothing,
      $sel:lastModifiedDate:Parameter' :: Maybe POSIX
lastModifiedDate = forall a. Maybe a
Prelude.Nothing,
      $sel:selector:Parameter' :: Maybe Text
selector = forall a. Maybe a
Prelude.Nothing,
      $sel:sourceResult:Parameter' :: Maybe Text
sourceResult = forall a. Maybe a
Prelude.Nothing,
      $sel:name:Parameter' :: Text
name = Text
pName_,
      $sel:type':Parameter' :: ParameterType
type' = ParameterType
pType_,
      $sel:value:Parameter' :: Sensitive Text
value = forall a. Iso' (Sensitive a) a
Data._Sensitive forall t b. AReview t b -> b -> t
Lens.# Text
pValue_,
      $sel:version:Parameter' :: Integer
version = Integer
pVersion_
    }

-- | The Amazon Resource Name (ARN) of the parameter.
parameter_arn :: Lens.Lens' Parameter (Prelude.Maybe Prelude.Text)
parameter_arn :: Lens' Parameter (Maybe Text)
parameter_arn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe Text
arn :: Maybe Text
$sel:arn:Parameter' :: Parameter -> Maybe Text
arn} -> Maybe Text
arn) (\s :: Parameter
s@Parameter' {} Maybe Text
a -> Parameter
s {$sel:arn:Parameter' :: Maybe Text
arn = Maybe Text
a} :: Parameter)

-- | The data type of the parameter, such as @text@ or @aws:ec2:image@. The
-- default is @text@.
parameter_dataType :: Lens.Lens' Parameter (Prelude.Maybe Prelude.Text)
parameter_dataType :: Lens' Parameter (Maybe Text)
parameter_dataType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe Text
dataType :: Maybe Text
$sel:dataType:Parameter' :: Parameter -> Maybe Text
dataType} -> Maybe Text
dataType) (\s :: Parameter
s@Parameter' {} Maybe Text
a -> Parameter
s {$sel:dataType:Parameter' :: Maybe Text
dataType = Maybe Text
a} :: Parameter)

-- | Date the parameter was last changed or updated and the parameter version
-- was created.
parameter_lastModifiedDate :: Lens.Lens' Parameter (Prelude.Maybe Prelude.UTCTime)
parameter_lastModifiedDate :: Lens' Parameter (Maybe UTCTime)
parameter_lastModifiedDate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe POSIX
lastModifiedDate :: Maybe POSIX
$sel:lastModifiedDate:Parameter' :: Parameter -> Maybe POSIX
lastModifiedDate} -> Maybe POSIX
lastModifiedDate) (\s :: Parameter
s@Parameter' {} Maybe POSIX
a -> Parameter
s {$sel:lastModifiedDate:Parameter' :: Maybe POSIX
lastModifiedDate = Maybe POSIX
a} :: Parameter) 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 (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | Either the version number or the label used to retrieve the parameter
-- value. Specify selectors by using one of the following formats:
--
-- parameter_name:version
--
-- parameter_name:label
parameter_selector :: Lens.Lens' Parameter (Prelude.Maybe Prelude.Text)
parameter_selector :: Lens' Parameter (Maybe Text)
parameter_selector = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe Text
selector :: Maybe Text
$sel:selector:Parameter' :: Parameter -> Maybe Text
selector} -> Maybe Text
selector) (\s :: Parameter
s@Parameter' {} Maybe Text
a -> Parameter
s {$sel:selector:Parameter' :: Maybe Text
selector = Maybe Text
a} :: Parameter)

-- | Applies to parameters that reference information in other Amazon Web
-- Services services. @SourceResult@ is the raw result or response from the
-- source.
parameter_sourceResult :: Lens.Lens' Parameter (Prelude.Maybe Prelude.Text)
parameter_sourceResult :: Lens' Parameter (Maybe Text)
parameter_sourceResult = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe Text
sourceResult :: Maybe Text
$sel:sourceResult:Parameter' :: Parameter -> Maybe Text
sourceResult} -> Maybe Text
sourceResult) (\s :: Parameter
s@Parameter' {} Maybe Text
a -> Parameter
s {$sel:sourceResult:Parameter' :: Maybe Text
sourceResult = Maybe Text
a} :: Parameter)

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

-- | The type of parameter. Valid values include the following: @String@,
-- @StringList@, and @SecureString@.
--
-- If type is @StringList@, the system returns a comma-separated string
-- with no spaces between commas in the @Value@ field.
parameter_type :: Lens.Lens' Parameter ParameterType
parameter_type :: Lens' Parameter ParameterType
parameter_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {ParameterType
type' :: ParameterType
$sel:type':Parameter' :: Parameter -> ParameterType
type'} -> ParameterType
type') (\s :: Parameter
s@Parameter' {} ParameterType
a -> Parameter
s {$sel:type':Parameter' :: ParameterType
type' = ParameterType
a} :: Parameter)

-- | The parameter value.
--
-- If type is @StringList@, the system returns a comma-separated string
-- with no spaces between commas in the @Value@ field.
parameter_value :: Lens.Lens' Parameter Prelude.Text
parameter_value :: Lens' Parameter Text
parameter_value = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Sensitive Text
value :: Sensitive Text
$sel:value:Parameter' :: Parameter -> Sensitive Text
value} -> Sensitive Text
value) (\s :: Parameter
s@Parameter' {} Sensitive Text
a -> Parameter
s {$sel:value:Parameter' :: Sensitive Text
value = Sensitive Text
a} :: Parameter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. Iso' (Sensitive a) a
Data._Sensitive

-- | The parameter version.
parameter_version :: Lens.Lens' Parameter Prelude.Integer
parameter_version :: Lens' Parameter Integer
parameter_version = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Integer
version :: Integer
$sel:version:Parameter' :: Parameter -> Integer
version} -> Integer
version) (\s :: Parameter
s@Parameter' {} Integer
a -> Parameter
s {$sel:version:Parameter' :: Integer
version = Integer
a} :: Parameter)

instance Data.FromJSON Parameter where
  parseJSON :: Value -> Parser Parameter
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Parameter"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Text
-> ParameterType
-> Sensitive Text
-> Integer
-> Parameter
Parameter'
            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
"ARN")
            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
"DataType")
            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
"LastModifiedDate")
            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
"Selector")
            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
"SourceResult")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser 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 a
Data..: Key
"Type")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Value")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Version")
      )

instance Prelude.Hashable Parameter where
  hashWithSalt :: Int -> Parameter -> Int
hashWithSalt Int
_salt Parameter' {Integer
Maybe Text
Maybe POSIX
Text
Sensitive Text
ParameterType
version :: Integer
value :: Sensitive Text
type' :: ParameterType
name :: Text
sourceResult :: Maybe Text
selector :: Maybe Text
lastModifiedDate :: Maybe POSIX
dataType :: Maybe Text
arn :: Maybe Text
$sel:version:Parameter' :: Parameter -> Integer
$sel:value:Parameter' :: Parameter -> Sensitive Text
$sel:type':Parameter' :: Parameter -> ParameterType
$sel:name:Parameter' :: Parameter -> Text
$sel:sourceResult:Parameter' :: Parameter -> Maybe Text
$sel:selector:Parameter' :: Parameter -> Maybe Text
$sel:lastModifiedDate:Parameter' :: Parameter -> Maybe POSIX
$sel:dataType:Parameter' :: Parameter -> Maybe Text
$sel:arn:Parameter' :: Parameter -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
arn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
dataType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
lastModifiedDate
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
selector
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
sourceResult
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ParameterType
type'
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Sensitive Text
value
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Integer
version

instance Prelude.NFData Parameter where
  rnf :: Parameter -> ()
rnf Parameter' {Integer
Maybe Text
Maybe POSIX
Text
Sensitive Text
ParameterType
version :: Integer
value :: Sensitive Text
type' :: ParameterType
name :: Text
sourceResult :: Maybe Text
selector :: Maybe Text
lastModifiedDate :: Maybe POSIX
dataType :: Maybe Text
arn :: Maybe Text
$sel:version:Parameter' :: Parameter -> Integer
$sel:value:Parameter' :: Parameter -> Sensitive Text
$sel:type':Parameter' :: Parameter -> ParameterType
$sel:name:Parameter' :: Parameter -> Text
$sel:sourceResult:Parameter' :: Parameter -> Maybe Text
$sel:selector:Parameter' :: Parameter -> Maybe Text
$sel:lastModifiedDate:Parameter' :: Parameter -> Maybe POSIX
$sel:dataType:Parameter' :: Parameter -> Maybe Text
$sel:arn:Parameter' :: Parameter -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
arn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
dataType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
lastModifiedDate
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
selector
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
sourceResult
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ParameterType
type'
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Sensitive Text
value
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Integer
version