Safe Haskell	None
Language	Haskell2010

Stratosphere.Parameters

Description

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html

You can use the optional Parameters section to pass values into your template when you create a stack. With parameters, you can create templates that are customized each time you create a stack. Each parameter must contain a value when you create a stack. You can specify a default value to make the parameter optional. For more information about creating stacks, see Working with Stacks.

Synopsis

data Parameter = Parameter {
- _parameterName :: Text
- _parameterType' :: Text
- _parameterDefault' :: Maybe Value
- _parameterNoEcho :: Maybe Bool'
- _parameterAllowedValues :: Maybe Array
- _parameterAllowedPattern :: Maybe Text
- _parameterMaxLength :: Maybe Integer
- _parameterMinLength :: Maybe Integer
- _parameterMaxValue :: Maybe Integer
- _parameterMinValue :: Maybe Integer
- _parameterDescription :: Maybe Text
- _parameterConstraintDescription :: Maybe Text
}
parameterType' :: Lens' Parameter Text
parameterNoEcho :: Lens' Parameter (Maybe Bool')
parameterName :: Lens' Parameter Text
parameterMinValue :: Lens' Parameter (Maybe Integer)
parameterMinLength :: Lens' Parameter (Maybe Integer)
parameterMaxValue :: Lens' Parameter (Maybe Integer)
parameterMaxLength :: Lens' Parameter (Maybe Integer)
parameterDescription :: Lens' Parameter (Maybe Text)
parameterDefault' :: Lens' Parameter (Maybe Value)
parameterConstraintDescription :: Lens' Parameter (Maybe Text)
parameterAllowedValues :: Lens' Parameter (Maybe Array)
parameterAllowedPattern :: Lens' Parameter (Maybe Text)
parameterToJSON :: Parameter -> Value
parameterFromJSON :: Text -> Object -> Parser Parameter
parameter :: Text -> Text -> Parameter
newtype Parameters = Parameters {
- unParameters :: [Parameter]
}

Documentation

data Parameter #

Constructors

Parameter

Fields

_parameterName :: Text
_parameterType' :: Text
The data type for the parameter.
_parameterDefault' :: Maybe Value
A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.
_parameterNoEcho :: Maybe Bool'
Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*****).
_parameterAllowedValues :: Maybe Array
An array containing the list of values allowed for the parameter.
_parameterAllowedPattern :: Maybe Text
A regular expression that represents the patterns you want to allow for String types.
_parameterMaxLength :: Maybe Integer
An integer value that determines the largest number of characters you want to allow for String types.
_parameterMinLength :: Maybe Integer
An integer value that determines the smallest number of characters you want to allow for String types.
_parameterMaxValue :: Maybe Integer
A numeric value that determines the largest numeric value you want to allow for Number types.
_parameterMinValue :: Maybe Integer
A numeric value that determines the smallest numeric value you want to allow for Number types.
_parameterDescription :: Maybe Text
A string of up to 4000 characters that describes the parameter.
_parameterConstraintDescription :: Maybe Text
A string that explains the constraint when the constraint is violated.

Instances

Eq Parameter #
Instance details Defined in Stratosphere.Parameters Methods (==) :: Parameter -> Parameter -> Bool # (/=) :: Parameter -> Parameter -> Bool #
Show Parameter #
Instance details Defined in Stratosphere.Parameters Methods showsPrec :: Int -> Parameter -> ShowS # show :: Parameter -> String # showList :: [Parameter] -> ShowS #
NamedItem Parameter #
Instance details Defined in Stratosphere.Parameters Methods itemName :: Parameter -> Text # nameToJSON :: Parameter -> Value # nameParseJSON :: Text -> Object -> Parser Parameter #
ToRef Parameter b #
Instance details Defined in Stratosphere.Parameters Methods toRef :: Parameter -> Val b #

parameterType' :: Lens' Parameter Text #

parameterNoEcho :: Lens' Parameter (Maybe Bool') #

parameterName :: Lens' Parameter Text #

parameterMinValue :: Lens' Parameter (Maybe Integer) #

parameterMinLength :: Lens' Parameter (Maybe Integer) #

parameterMaxValue :: Lens' Parameter (Maybe Integer) #

parameterMaxLength :: Lens' Parameter (Maybe Integer) #

parameterDescription :: Lens' Parameter (Maybe Text) #

parameterDefault' :: Lens' Parameter (Maybe Value) #

parameterConstraintDescription :: Lens' Parameter (Maybe Text) #

parameterAllowedValues :: Lens' Parameter (Maybe Array) #

parameterAllowedPattern :: Lens' Parameter (Maybe Text) #

parameterToJSON :: Parameter -> Value #

parameterFromJSON :: Text -> Object -> Parser Parameter #

parameter #

Arguments

:: Text	Name
-> Text	Type
-> Parameter

Constructor for Parameter with required arguments.

newtype Parameters #

Wrapper around a list of Parameterss to we can modify the aeson instances.

Constructors

Parameters
Fields unParameters :: [Parameter]

Instances

IsList Parameters #
Instance details Defined in Stratosphere.Parameters Associated Types type Item Parameters :: * # Methods fromList :: [Item Parameters] -> Parameters # fromListN :: Int -> [Item Parameters] -> Parameters # toList :: Parameters -> [Item Parameters] #
Eq Parameters #
Instance details Defined in Stratosphere.Parameters Methods (==) :: Parameters -> Parameters -> Bool # (/=) :: Parameters -> Parameters -> Bool #
Show Parameters #
Instance details Defined in Stratosphere.Parameters Methods showsPrec :: Int -> Parameters -> ShowS # show :: Parameters -> String # showList :: [Parameters] -> ShowS #
Semigroup Parameters #
Instance details Defined in Stratosphere.Parameters Methods (<>) :: Parameters -> Parameters -> Parameters # sconcat :: NonEmpty Parameters -> Parameters # stimes :: Integral b => b -> Parameters -> Parameters #
Monoid Parameters #
Instance details Defined in Stratosphere.Parameters Methods mempty :: Parameters # mappend :: Parameters -> Parameters -> Parameters # mconcat :: [Parameters] -> Parameters #
ToJSON Parameters #
Instance details Defined in Stratosphere.Parameters Methods toJSON :: Parameters -> Value # toEncoding :: Parameters -> Encoding # toJSONList :: [Parameters] -> Value # toEncodingList :: [Parameters] -> Encoding #
FromJSON Parameters #
Instance details Defined in Stratosphere.Parameters Methods parseJSON :: Value -> Parser Parameters # parseJSONList :: Value -> Parser [Parameters] #
type Item Parameters #
Instance details Defined in Stratosphere.Parameters type Item Parameters = Parameter