Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.Types.Parameter

Description

Synopsis

data Parameter = Parameter' {
- applyType :: Maybe Text
- parameterValue :: Maybe Text
- applyMethod :: Maybe ApplyMethod
- minimumEngineVersion :: Maybe Text
- source :: Maybe Text
- isModifiable :: Maybe Bool
- dataType :: Maybe Text
- allowedValues :: Maybe Text
- parameterName :: Maybe Text
- description :: Maybe Text
}
newParameter :: Parameter
parameter_applyType :: Lens' Parameter (Maybe Text)
parameter_parameterValue :: Lens' Parameter (Maybe Text)
parameter_applyMethod :: Lens' Parameter (Maybe ApplyMethod)
parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text)
parameter_source :: Lens' Parameter (Maybe Text)
parameter_isModifiable :: Lens' Parameter (Maybe Bool)
parameter_dataType :: Lens' Parameter (Maybe Text)
parameter_allowedValues :: Lens' Parameter (Maybe Text)
parameter_parameterName :: Lens' Parameter (Maybe Text)
parameter_description :: Lens' Parameter (Maybe Text)

Documentation

data Parameter Source #

Detailed information about an individual parameter.

See: newParameter smart constructor.

Constructors

Parameter'

Fields

applyType :: Maybe Text
Specifies the engine-specific parameters type.
parameterValue :: Maybe Text
Specifies the value of the parameter.
applyMethod :: Maybe ApplyMethod
Indicates when to apply parameter updates.
minimumEngineVersion :: Maybe Text
The earliest engine version to which the parameter can apply.
source :: Maybe Text
Indicates the source of the parameter value.
isModifiable :: Maybe Bool
Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
dataType :: Maybe Text
Specifies the valid data type for the parameter.
allowedValues :: Maybe Text
Specifies the valid range of values for the parameter.
parameterName :: Maybe Text
Specifies the name of the parameter.
description :: Maybe Text
Provides a description of the parameter.

Instances

Instances details

Eq Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods (==) :: Parameter -> Parameter -> Bool # (/=) :: Parameter -> Parameter -> Bool #
Read Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods readsPrec :: Int -> ReadS Parameter # readList :: ReadS [Parameter] # readPrec :: ReadPrec Parameter # readListPrec :: ReadPrec [Parameter] #
Show Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods showsPrec :: Int -> Parameter -> ShowS # show :: Parameter -> String # showList :: [Parameter] -> ShowS #
Generic Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Associated Types type Rep Parameter :: Type -> Type # Methods from :: Parameter -> Rep Parameter x # to :: Rep Parameter x -> Parameter #
NFData Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods rnf :: Parameter -> () #
Hashable Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods hashWithSalt :: Int -> Parameter -> Int # hash :: Parameter -> Int #
ToQuery Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods toQuery :: Parameter -> QueryString #
FromXML Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter Methods parseXML :: [Node] -> Either String Parameter #
type Rep Parameter Source #
Instance details Defined in Amazonka.DocumentDB.Types.Parameter type Rep Parameter = D1 ('MetaData "Parameter" "Amazonka.DocumentDB.Types.Parameter" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "Parameter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameterValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "applyMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApplyMethod)) :: (S1 ('MetaSel ('Just "minimumEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "isModifiable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "allowedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newParameter :: Parameter Source #

Create a value of Parameter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:applyType:Parameter', parameter_applyType - Specifies the engine-specific parameters type.

$sel:parameterValue:Parameter', parameter_parameterValue - Specifies the value of the parameter.

$sel:applyMethod:Parameter', parameter_applyMethod - Indicates when to apply parameter updates.

$sel:minimumEngineVersion:Parameter', parameter_minimumEngineVersion - The earliest engine version to which the parameter can apply.

$sel:source:Parameter', parameter_source - Indicates the source of the parameter value.

$sel:isModifiable:Parameter', parameter_isModifiable - Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

$sel:dataType:Parameter', parameter_dataType - Specifies the valid data type for the parameter.

$sel:allowedValues:Parameter', parameter_allowedValues - Specifies the valid range of values for the parameter.

$sel:parameterName:Parameter', parameter_parameterName - Specifies the name of the parameter.

$sel:description:Parameter', parameter_description - Provides a description of the parameter.

parameter_applyType :: Lens' Parameter (Maybe Text) Source #

Specifies the engine-specific parameters type.

parameter_parameterValue :: Lens' Parameter (Maybe Text) Source #

Specifies the value of the parameter.

parameter_applyMethod :: Lens' Parameter (Maybe ApplyMethod) Source #

Indicates when to apply parameter updates.

parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text) Source #

The earliest engine version to which the parameter can apply.

parameter_source :: Lens' Parameter (Maybe Text) Source #

Indicates the source of the parameter value.

parameter_isModifiable :: Lens' Parameter (Maybe Bool) Source #

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

parameter_dataType :: Lens' Parameter (Maybe Text) Source #

Specifies the valid data type for the parameter.

parameter_allowedValues :: Lens' Parameter (Maybe Text) Source #

Specifies the valid range of values for the parameter.

parameter_parameterName :: Lens' Parameter (Maybe Text) Source #

Specifies the name of the parameter.

parameter_description :: Lens' Parameter (Maybe Text) Source #

Provides a description of the parameter.