Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Redshift.Types.Parameter

Description

Synopsis

Documentation

data Parameter Source #

Describes a parameter in a cluster parameter group.

See: newParameter smart constructor.

Constructors

Parameter'

Fields

allowedValues :: Maybe Text
The valid range of values for the parameter.
applyType :: Maybe ParameterApplyType
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 Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
dataType :: Maybe Text
The data type of the parameter.
description :: Maybe Text
A description of the parameter.
isModifiable :: Maybe Bool
If true, 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
The name of the parameter.
parameterValue :: Maybe Text
The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.
source :: Maybe Text
The source of the parameter value, such as "engine-default" or "user".

Instances

Instances details

ToQuery Parameter Source #
Instance details Defined in Amazonka.Redshift.Types.Parameter Methods toQuery :: Parameter -> QueryString #
FromXML Parameter Source #
Instance details Defined in Amazonka.Redshift.Types.Parameter Methods parseXML :: [Node] -> Either String Parameter #
Generic Parameter Source #
Instance details Defined in Amazonka.Redshift.Types.Parameter Associated Types type Rep Parameter :: Type -> Type # Methods from :: Parameter -> Rep Parameter x # to :: Rep Parameter x -> Parameter #
Read Parameter Source #
Instance details Defined in Amazonka.Redshift.Types.Parameter Methods readsPrec :: Int -> ReadS Parameter # readList :: ReadS [Parameter] # readPrec :: ReadPrec Parameter # readListPrec :: ReadPrec [Parameter] #
Show Parameter Source #
Instance details Defined in Amazonka.Redshift.Types.Parameter Methods showsPrec :: Int -> Parameter -> ShowS # show :: Parameter -> String # showList :: [Parameter] -> ShowS #
NFData Parameter Source #
Instance details Defined in Amazonka.Redshift.Types.Parameter Methods rnf :: Parameter -> () #
Eq Parameter Source #
Instance details Defined in Amazonka.Redshift.Types.Parameter Methods (==) :: Parameter -> Parameter -> Bool # (/=) :: Parameter -> Parameter -> Bool #
Hashable Parameter Source #
Instance details Defined in Amazonka.Redshift.Types.Parameter Methods hashWithSalt :: Int -> Parameter -> Int # hash :: Parameter -> Int #
type Rep Parameter Source #
Instance details Defined in Amazonka.Redshift.Types.Parameter type Rep Parameter = D1 ('MetaData "Parameter" "Amazonka.Redshift.Types.Parameter" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "Parameter'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "allowedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "applyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParameterApplyType))) :: (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 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:allowedValues:Parameter', parameter_allowedValues - The valid range of values for the parameter.

$sel:applyType:Parameter', 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 Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

$sel:dataType:Parameter', parameter_dataType - The data type of the parameter.

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

$sel:isModifiable:Parameter', parameter_isModifiable - If true, 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 - The name of the parameter.

$sel:parameterValue:Parameter', parameter_parameterValue - The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

$sel:source:Parameter', parameter_source - The source of the parameter value, such as "engine-default" or "user".

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

The valid range of values for the parameter.

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

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 Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

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

The data type of the parameter.

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

A description of the parameter.

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

If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

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

The earliest engine version to which the parameter can apply.

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

The name of the parameter.

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

The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

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

The source of the parameter value, such as "engine-default" or "user".