Amazonka.Neptune.Types.Parameter

Documentation

data Parameter

Specifies a parameter.

See: newParameter smart constructor.

Constructors

Parameter'

Fields

• allowedValues :: Maybe Text

  Specifies the valid range of values for the parameter.

• applyMethod :: Maybe ApplyMethod

  Indicates when to apply parameter updates.

• applyType :: Maybe Text

  Specifies the engine specific parameters type.

• dataType :: Maybe Text

  Specifies the valid data type for the parameter.

• description :: Maybe Text

  Provides a description of the parameter.

• 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.

• minimumEngineVersion :: Maybe Text

  The earliest engine version to which the parameter can apply.

• parameterName :: Maybe Text

  Specifies the name of the parameter.

• parameterValue :: Maybe Text

  Specifies the value of the parameter.

• source :: Maybe Text

  Indicates the source of the parameter value.

Instances

ToQuery Parameter

Defined in Amazonka.Neptune.Types.Parameter

Methods

toQuery :: Parameter -> QueryString

FromXML Parameter

Defined in Amazonka.Neptune.Types.Parameter

Methods

parseXML :: [Node] -> Either String Parameter

Generic Parameter

Defined in Amazonka.Neptune.Types.Parameter

Associated Types

type Rep Parameter :: Type -> Type

Methods

from :: Parameter -> Rep Parameter x

to :: Rep Parameter x -> Parameter

Read Parameter

Defined in Amazonka.Neptune.Types.Parameter

Methods

readsPrec :: Int -> ReadS Parameter

readList :: ReadS [Parameter]

readPrec :: ReadPrec Parameter

readListPrec :: ReadPrec [Parameter]

Show Parameter

Defined in Amazonka.Neptune.Types.Parameter

Methods

showsPrec :: Int -> Parameter -> ShowS

show :: Parameter -> String

showList :: [Parameter] -> ShowS

NFData Parameter

Defined in Amazonka.Neptune.Types.Parameter

Methods

rnf :: Parameter -> ()

Eq Parameter

Defined in Amazonka.Neptune.Types.Parameter

Methods

(==) :: Parameter -> Parameter -> Bool

(/=) :: Parameter -> Parameter -> Bool

Hashable Parameter

Defined in Amazonka.Neptune.Types.Parameter

Methods

hashWithSalt :: Int -> Parameter -> Int

hash :: Parameter -> Int

type Rep Parameter

Defined in Amazonka.Neptune.Types.Parameter

type Rep Parameter = D1 ('MetaData "Parameter" "Amazonka.Neptune.Types.Parameter" "amazonka-neptune-2.0-2gYqDRsIJxo6L8BEj2Stvk" 'False) (C1 ('MetaCons "Parameter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applyMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApplyMethod))) :*: (S1 ('MetaSel ('Just "applyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "isModifiable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "minimumEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "parameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameterValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "source") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newParameter :: Parameter

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:allowedValues:Parameter', parameter_allowedValues - Specifies the valid range of values for the parameter.

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

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

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

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

$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:minimumEngineVersion:Parameter', parameter_minimumEngineVersion - The earliest engine version to which the parameter can apply.

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

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

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

parameter_allowedValues :: Lens' Parameter (Maybe Text)

Specifies the valid range of values for the parameter.

parameter_applyMethod :: Lens' Parameter (Maybe ApplyMethod)

Indicates when to apply parameter updates.

parameter_applyType :: Lens' Parameter (Maybe Text)

Specifies the engine specific parameters type.

parameter_dataType :: Lens' Parameter (Maybe Text)

Specifies the valid data type for the parameter.

parameter_description :: Lens' Parameter (Maybe Text)

Provides a description of the parameter.

parameter_isModifiable :: Lens' Parameter (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.

parameter_minimumEngineVersion :: Lens' Parameter (Maybe Text)

The earliest engine version to which the parameter can apply.

parameter_parameterName :: Lens' Parameter (Maybe Text)

Specifies the name of the parameter.

parameter_parameterValue :: Lens' Parameter (Maybe Text)

Specifies the value of the parameter.

parameter_source :: Lens' Parameter (Maybe Text)

Indicates the source of the parameter value.