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.QuickSight.Types.StringParameterDeclaration

Description

Documentation

data StringParameterDeclaration Source #

A parameter declaration for the String data type.

See: newStringParameterDeclaration smart constructor.

Constructors

StringParameterDeclaration'

Fields

defaultValues :: Maybe StringDefaultValues
The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
valueWhenUnset :: Maybe StringValueWhenUnsetConfiguration
The configuration that defines the default value of a String parameter when a value has not been set.
parameterValueType :: ParameterValueType
The value type determines whether the parameter is a single-value or multi-value parameter.
name :: Text
The name of the parameter that is being declared.

Instances

Instances details

FromJSON StringParameterDeclaration Source #
Instance details Defined in Amazonka.QuickSight.Types.StringParameterDeclaration Methods parseJSON :: Value -> Parser StringParameterDeclaration # parseJSONList :: Value -> Parser [StringParameterDeclaration] #
ToJSON StringParameterDeclaration Source #
Instance details Defined in Amazonka.QuickSight.Types.StringParameterDeclaration Methods toJSON :: StringParameterDeclaration -> Value # toEncoding :: StringParameterDeclaration -> Encoding # toJSONList :: [StringParameterDeclaration] -> Value # toEncodingList :: [StringParameterDeclaration] -> Encoding #
Generic StringParameterDeclaration Source #
Instance details Defined in Amazonka.QuickSight.Types.StringParameterDeclaration Associated Types type Rep StringParameterDeclaration :: Type -> Type # Methods from :: StringParameterDeclaration -> Rep StringParameterDeclaration x # to :: Rep StringParameterDeclaration x -> StringParameterDeclaration #
Show StringParameterDeclaration Source #
Instance details Defined in Amazonka.QuickSight.Types.StringParameterDeclaration Methods showsPrec :: Int -> StringParameterDeclaration -> ShowS # show :: StringParameterDeclaration -> String # showList :: [StringParameterDeclaration] -> ShowS #
NFData StringParameterDeclaration Source #
Instance details Defined in Amazonka.QuickSight.Types.StringParameterDeclaration Methods rnf :: StringParameterDeclaration -> () #
Eq StringParameterDeclaration Source #
Instance details Defined in Amazonka.QuickSight.Types.StringParameterDeclaration Methods (==) :: StringParameterDeclaration -> StringParameterDeclaration -> Bool # (/=) :: StringParameterDeclaration -> StringParameterDeclaration -> Bool #
Hashable StringParameterDeclaration Source #
Instance details Defined in Amazonka.QuickSight.Types.StringParameterDeclaration Methods hashWithSalt :: Int -> StringParameterDeclaration -> Int # hash :: StringParameterDeclaration -> Int #
type Rep StringParameterDeclaration Source #
Instance details Defined in Amazonka.QuickSight.Types.StringParameterDeclaration type Rep StringParameterDeclaration = D1 ('MetaData "StringParameterDeclaration" "Amazonka.QuickSight.Types.StringParameterDeclaration" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "StringParameterDeclaration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StringDefaultValues)) :: S1 ('MetaSel ('Just "valueWhenUnset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StringValueWhenUnsetConfiguration))) :: (S1 ('MetaSel ('Just "parameterValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ParameterValueType) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStringParameterDeclaration Source #

Arguments

:: ParameterValueType	`$sel:parameterValueType:StringParameterDeclaration'`
-> Text	`$sel:name:StringParameterDeclaration'`
-> StringParameterDeclaration

Create a value of StringParameterDeclaration 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:defaultValues:StringParameterDeclaration', stringParameterDeclaration_defaultValues - The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

$sel:valueWhenUnset:StringParameterDeclaration', stringParameterDeclaration_valueWhenUnset - The configuration that defines the default value of a String parameter when a value has not been set.

$sel:parameterValueType:StringParameterDeclaration', stringParameterDeclaration_parameterValueType - The value type determines whether the parameter is a single-value or multi-value parameter.

$sel:name:StringParameterDeclaration', stringParameterDeclaration_name - The name of the parameter that is being declared.

stringParameterDeclaration_defaultValues :: Lens' StringParameterDeclaration (Maybe StringDefaultValues) Source #

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

stringParameterDeclaration_valueWhenUnset :: Lens' StringParameterDeclaration (Maybe StringValueWhenUnsetConfiguration) Source #

The configuration that defines the default value of a String parameter when a value has not been set.

stringParameterDeclaration_parameterValueType :: Lens' StringParameterDeclaration ParameterValueType Source #

The value type determines whether the parameter is a single-value or multi-value parameter.

stringParameterDeclaration_name :: Lens' StringParameterDeclaration Text Source #

The name of the parameter that is being declared.