{-# 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.Redshift.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.Redshift.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.Redshift.Internal
import Amazonka.Redshift.Types.ParameterApplyType

-- | Describes a parameter in a cluster parameter group.
--
-- /See:/ 'newParameter' smart constructor.
data Parameter = Parameter'
  { -- | The valid range of values for the parameter.
    Parameter -> Maybe Text
allowedValues :: Prelude.Maybe Prelude.Text,
    -- | Specifies how to apply the WLM configuration parameter. Some properties
    -- can be applied dynamically, while other properties require that any
    -- associated clusters be rebooted for the configuration changes to be
    -- applied. For more information about parameters and parameter groups, go
    -- to
    -- <https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html Amazon Redshift Parameter Groups>
    -- in the /Amazon Redshift Cluster Management Guide/.
    Parameter -> Maybe ParameterApplyType
applyType :: Prelude.Maybe ParameterApplyType,
    -- | The data type of the parameter.
    Parameter -> Maybe Text
dataType :: Prelude.Maybe Prelude.Text,
    -- | A description of the parameter.
    Parameter -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | If @true@, the parameter can be modified. Some parameters have security
    -- or operational implications that prevent them from being changed.
    Parameter -> Maybe Bool
isModifiable :: Prelude.Maybe Prelude.Bool,
    -- | The earliest engine version to which the parameter can apply.
    Parameter -> Maybe Text
minimumEngineVersion :: Prelude.Maybe Prelude.Text,
    -- | The name of the parameter.
    Parameter -> Maybe Text
parameterName :: Prelude.Maybe Prelude.Text,
    -- | The value of the parameter. If @ParameterName@ is
    -- @wlm_json_configuration@, then the maximum size of @ParameterValue@ is
    -- 8000 characters.
    Parameter -> Maybe Text
parameterValue :: Prelude.Maybe Prelude.Text,
    -- | The source of the parameter value, such as \"engine-default\" or
    -- \"user\".
    Parameter -> Maybe Text
source :: Prelude.Maybe Prelude.Text
  }
  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, ReadPrec [Parameter]
ReadPrec Parameter
Int -> ReadS Parameter
ReadS [Parameter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Parameter]
$creadListPrec :: ReadPrec [Parameter]
readPrec :: ReadPrec Parameter
$creadPrec :: ReadPrec Parameter
readList :: ReadS [Parameter]
$creadList :: ReadS [Parameter]
readsPrec :: Int -> ReadS Parameter
$creadsPrec :: Int -> ReadS Parameter
Prelude.Read, 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:
--
-- 'allowedValues', 'parameter_allowedValues' - The valid range of values for the parameter.
--
-- 'applyType', 'parameter_applyType' - Specifies how to apply the WLM configuration parameter. Some properties
-- can be applied dynamically, while other properties require that any
-- associated clusters be rebooted for the configuration changes to be
-- applied. For more information about parameters and parameter groups, go
-- to
-- <https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html Amazon Redshift Parameter Groups>
-- in the /Amazon Redshift Cluster Management Guide/.
--
-- 'dataType', 'parameter_dataType' - The data type of the parameter.
--
-- 'description', 'parameter_description' - A description of the parameter.
--
-- 'isModifiable', 'parameter_isModifiable' - If @true@, the parameter can be modified. Some parameters have security
-- or operational implications that prevent them from being changed.
--
-- 'minimumEngineVersion', 'parameter_minimumEngineVersion' - The earliest engine version to which the parameter can apply.
--
-- 'parameterName', 'parameter_parameterName' - The name of the parameter.
--
-- 'parameterValue', 'parameter_parameterValue' - The value of the parameter. If @ParameterName@ is
-- @wlm_json_configuration@, then the maximum size of @ParameterValue@ is
-- 8000 characters.
--
-- 'source', 'parameter_source' - The source of the parameter value, such as \"engine-default\" or
-- \"user\".
newParameter ::
  Parameter
newParameter :: Parameter
newParameter =
  Parameter'
    { $sel:allowedValues:Parameter' :: Maybe Text
allowedValues = forall a. Maybe a
Prelude.Nothing,
      $sel:applyType:Parameter' :: Maybe ParameterApplyType
applyType = forall a. Maybe a
Prelude.Nothing,
      $sel:dataType:Parameter' :: Maybe Text
dataType = forall a. Maybe a
Prelude.Nothing,
      $sel:description:Parameter' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:isModifiable:Parameter' :: Maybe Bool
isModifiable = forall a. Maybe a
Prelude.Nothing,
      $sel:minimumEngineVersion:Parameter' :: Maybe Text
minimumEngineVersion = forall a. Maybe a
Prelude.Nothing,
      $sel:parameterName:Parameter' :: Maybe Text
parameterName = forall a. Maybe a
Prelude.Nothing,
      $sel:parameterValue:Parameter' :: Maybe Text
parameterValue = forall a. Maybe a
Prelude.Nothing,
      $sel:source:Parameter' :: Maybe Text
source = forall a. Maybe a
Prelude.Nothing
    }

-- | The valid range of values for the parameter.
parameter_allowedValues :: Lens.Lens' Parameter (Prelude.Maybe Prelude.Text)
parameter_allowedValues :: Lens' Parameter (Maybe Text)
parameter_allowedValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe Text
allowedValues :: Maybe Text
$sel:allowedValues:Parameter' :: Parameter -> Maybe Text
allowedValues} -> Maybe Text
allowedValues) (\s :: Parameter
s@Parameter' {} Maybe Text
a -> Parameter
s {$sel:allowedValues:Parameter' :: Maybe Text
allowedValues = Maybe Text
a} :: Parameter)

-- | Specifies how to apply the WLM configuration parameter. Some properties
-- can be applied dynamically, while other properties require that any
-- associated clusters be rebooted for the configuration changes to be
-- applied. For more information about parameters and parameter groups, go
-- to
-- <https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html Amazon Redshift Parameter Groups>
-- in the /Amazon Redshift Cluster Management Guide/.
parameter_applyType :: Lens.Lens' Parameter (Prelude.Maybe ParameterApplyType)
parameter_applyType :: Lens' Parameter (Maybe ParameterApplyType)
parameter_applyType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe ParameterApplyType
applyType :: Maybe ParameterApplyType
$sel:applyType:Parameter' :: Parameter -> Maybe ParameterApplyType
applyType} -> Maybe ParameterApplyType
applyType) (\s :: Parameter
s@Parameter' {} Maybe ParameterApplyType
a -> Parameter
s {$sel:applyType:Parameter' :: Maybe ParameterApplyType
applyType = Maybe ParameterApplyType
a} :: Parameter)

-- | The data type of the parameter.
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)

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

-- | If @true@, the parameter can be modified. Some parameters have security
-- or operational implications that prevent them from being changed.
parameter_isModifiable :: Lens.Lens' Parameter (Prelude.Maybe Prelude.Bool)
parameter_isModifiable :: Lens' Parameter (Maybe Bool)
parameter_isModifiable = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe Bool
isModifiable :: Maybe Bool
$sel:isModifiable:Parameter' :: Parameter -> Maybe Bool
isModifiable} -> Maybe Bool
isModifiable) (\s :: Parameter
s@Parameter' {} Maybe Bool
a -> Parameter
s {$sel:isModifiable:Parameter' :: Maybe Bool
isModifiable = Maybe Bool
a} :: Parameter)

-- | The earliest engine version to which the parameter can apply.
parameter_minimumEngineVersion :: Lens.Lens' Parameter (Prelude.Maybe Prelude.Text)
parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text)
parameter_minimumEngineVersion = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe Text
minimumEngineVersion :: Maybe Text
$sel:minimumEngineVersion:Parameter' :: Parameter -> Maybe Text
minimumEngineVersion} -> Maybe Text
minimumEngineVersion) (\s :: Parameter
s@Parameter' {} Maybe Text
a -> Parameter
s {$sel:minimumEngineVersion:Parameter' :: Maybe Text
minimumEngineVersion = Maybe Text
a} :: Parameter)

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

-- | The value of the parameter. If @ParameterName@ is
-- @wlm_json_configuration@, then the maximum size of @ParameterValue@ is
-- 8000 characters.
parameter_parameterValue :: Lens.Lens' Parameter (Prelude.Maybe Prelude.Text)
parameter_parameterValue :: Lens' Parameter (Maybe Text)
parameter_parameterValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe Text
parameterValue :: Maybe Text
$sel:parameterValue:Parameter' :: Parameter -> Maybe Text
parameterValue} -> Maybe Text
parameterValue) (\s :: Parameter
s@Parameter' {} Maybe Text
a -> Parameter
s {$sel:parameterValue:Parameter' :: Maybe Text
parameterValue = Maybe Text
a} :: Parameter)

-- | The source of the parameter value, such as \"engine-default\" or
-- \"user\".
parameter_source :: Lens.Lens' Parameter (Prelude.Maybe Prelude.Text)
parameter_source :: Lens' Parameter (Maybe Text)
parameter_source = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Parameter' {Maybe Text
source :: Maybe Text
$sel:source:Parameter' :: Parameter -> Maybe Text
source} -> Maybe Text
source) (\s :: Parameter
s@Parameter' {} Maybe Text
a -> Parameter
s {$sel:source:Parameter' :: Maybe Text
source = Maybe Text
a} :: Parameter)

instance Data.FromXML Parameter where
  parseXML :: [Node] -> Either String Parameter
parseXML [Node]
x =
    Maybe Text
-> Maybe ParameterApplyType
-> Maybe Text
-> Maybe Text
-> Maybe Bool
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Parameter
Parameter'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"AllowedValues")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"ApplyType")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"DataType")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Description")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"IsModifiable")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"MinimumEngineVersion")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"ParameterName")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"ParameterValue")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Source")

instance Prelude.Hashable Parameter where
  hashWithSalt :: Int -> Parameter -> Int
hashWithSalt Int
_salt Parameter' {Maybe Bool
Maybe Text
Maybe ParameterApplyType
source :: Maybe Text
parameterValue :: Maybe Text
parameterName :: Maybe Text
minimumEngineVersion :: Maybe Text
isModifiable :: Maybe Bool
description :: Maybe Text
dataType :: Maybe Text
applyType :: Maybe ParameterApplyType
allowedValues :: Maybe Text
$sel:source:Parameter' :: Parameter -> Maybe Text
$sel:parameterValue:Parameter' :: Parameter -> Maybe Text
$sel:parameterName:Parameter' :: Parameter -> Maybe Text
$sel:minimumEngineVersion:Parameter' :: Parameter -> Maybe Text
$sel:isModifiable:Parameter' :: Parameter -> Maybe Bool
$sel:description:Parameter' :: Parameter -> Maybe Text
$sel:dataType:Parameter' :: Parameter -> Maybe Text
$sel:applyType:Parameter' :: Parameter -> Maybe ParameterApplyType
$sel:allowedValues:Parameter' :: Parameter -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
allowedValues
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ParameterApplyType
applyType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
dataType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
isModifiable
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
minimumEngineVersion
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
parameterName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
parameterValue
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
source

instance Prelude.NFData Parameter where
  rnf :: Parameter -> ()
rnf Parameter' {Maybe Bool
Maybe Text
Maybe ParameterApplyType
source :: Maybe Text
parameterValue :: Maybe Text
parameterName :: Maybe Text
minimumEngineVersion :: Maybe Text
isModifiable :: Maybe Bool
description :: Maybe Text
dataType :: Maybe Text
applyType :: Maybe ParameterApplyType
allowedValues :: Maybe Text
$sel:source:Parameter' :: Parameter -> Maybe Text
$sel:parameterValue:Parameter' :: Parameter -> Maybe Text
$sel:parameterName:Parameter' :: Parameter -> Maybe Text
$sel:minimumEngineVersion:Parameter' :: Parameter -> Maybe Text
$sel:isModifiable:Parameter' :: Parameter -> Maybe Bool
$sel:description:Parameter' :: Parameter -> Maybe Text
$sel:dataType:Parameter' :: Parameter -> Maybe Text
$sel:applyType:Parameter' :: Parameter -> Maybe ParameterApplyType
$sel:allowedValues:Parameter' :: Parameter -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
allowedValues
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterApplyType
applyType
      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 Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
isModifiable
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
minimumEngineVersion
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
parameterName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
parameterValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
source

instance Data.ToQuery Parameter where
  toQuery :: Parameter -> QueryString
toQuery Parameter' {Maybe Bool
Maybe Text
Maybe ParameterApplyType
source :: Maybe Text
parameterValue :: Maybe Text
parameterName :: Maybe Text
minimumEngineVersion :: Maybe Text
isModifiable :: Maybe Bool
description :: Maybe Text
dataType :: Maybe Text
applyType :: Maybe ParameterApplyType
allowedValues :: Maybe Text
$sel:source:Parameter' :: Parameter -> Maybe Text
$sel:parameterValue:Parameter' :: Parameter -> Maybe Text
$sel:parameterName:Parameter' :: Parameter -> Maybe Text
$sel:minimumEngineVersion:Parameter' :: Parameter -> Maybe Text
$sel:isModifiable:Parameter' :: Parameter -> Maybe Bool
$sel:description:Parameter' :: Parameter -> Maybe Text
$sel:dataType:Parameter' :: Parameter -> Maybe Text
$sel:applyType:Parameter' :: Parameter -> Maybe ParameterApplyType
$sel:allowedValues:Parameter' :: Parameter -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"AllowedValues" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
allowedValues,
        ByteString
"ApplyType" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe ParameterApplyType
applyType,
        ByteString
"DataType" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
dataType,
        ByteString
"Description" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
description,
        ByteString
"IsModifiable" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Bool
isModifiable,
        ByteString
"MinimumEngineVersion" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
minimumEngineVersion,
        ByteString
"ParameterName" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
parameterName,
        ByteString
"ParameterValue" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
parameterValue,
        ByteString
"Source" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
source
      ]