stratosphere-0.1.0: EDSL for AWS CloudFormation

Safe HaskellNone
LanguageHaskell2010

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

Documentation

data Parameter Source

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.

class HasAllowedValues s a | s -> a where Source

Methods

allowedValues :: Lens' s a Source

class HasDefault' s a | s -> a where Source

Methods

default' :: Lens' s a Source

class HasMaxLength s a | s -> a where Source

Methods

maxLength :: Lens' s a Source

class HasMaxValue s a | s -> a where Source

Methods

maxValue :: Lens' s a Source

class HasMinLength s a | s -> a where Source

Methods

minLength :: Lens' s a Source

class HasMinValue s a | s -> a where Source

Methods

minValue :: Lens' s a Source

class HasName s a | s -> a where Source

Methods

name :: Lens' s a Source

class HasNoEcho s a | s -> a where Source

Methods

noEcho :: Lens' s a Source

class HasType' s a | s -> a where Source

Methods

type' :: Lens' s a Source

parameter Source

Arguments

:: Text

Name

-> Text

Type

-> Parameter 

Constructor for Parameter with required arguments.

newtype Parameters Source

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

Constructors

Parameters 

Fields

unParameters :: [Parameter]