stratosphere-1.0.0: EDSL for AWS CloudFormation
Safe HaskellNone
LanguageHaskell2010

Stratosphere.Parameter

Description

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

  • name :: Text
     
  • type' :: Text

    The data type for the parameter.

  • default' :: 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.

  • noEcho :: 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 (*****).

  • allowedValues :: Maybe Array

    An array containing the list of values allowed for the parameter.

  • allowedPattern :: Maybe Text

    A regular expression that represents the patterns you want to allow for String types.

  • maxLength :: Maybe Integer

    An integer value that determines the largest number of characters you want to allow for String types.

  • minLength :: Maybe Integer

    An integer value that determines the smallest number of characters you want to allow for String types.

  • maxValue :: Maybe Integer

    A numeric value that determines the largest numeric value you want to allow for Number types.

  • minValue :: Maybe Integer

    A numeric value that determines the smallest numeric value you want to allow for Number types.

  • description :: Maybe Text

    A string of up to 4000 characters that describes the parameter.

  • constraintDescription :: Maybe Text

    A string that explains the constraint when the constraint is violated.

Instances

Instances details
Show Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Eq Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

NamedItem Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Property "AllowedPattern" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "AllowedPattern" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "AllowedPattern" Parameter = Text

Methods

set :: PropertyType "AllowedPattern" Parameter -> Parameter -> Parameter Source #

Property "AllowedValues" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "AllowedValues" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "AllowedValues" Parameter = Array

Methods

set :: PropertyType "AllowedValues" Parameter -> Parameter -> Parameter Source #

Property "ConstraintDescription" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "ConstraintDescription" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "ConstraintDescription" Parameter = Text

Methods

set :: PropertyType "ConstraintDescription" Parameter -> Parameter -> Parameter Source #

Property "Default" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "Default" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "Default" Parameter = Value
Property "Description" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "Description" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "Description" Parameter = Text

Methods

set :: PropertyType "Description" Parameter -> Parameter -> Parameter Source #

Property "MaxLength" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "MaxLength" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "MaxLength" Parameter = Integer

Methods

set :: PropertyType "MaxLength" Parameter -> Parameter -> Parameter Source #

Property "MaxValue" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "MaxValue" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "MaxValue" Parameter = Integer

Methods

set :: PropertyType "MaxValue" Parameter -> Parameter -> Parameter Source #

Property "MinLength" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "MinLength" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "MinLength" Parameter = Integer

Methods

set :: PropertyType "MinLength" Parameter -> Parameter -> Parameter Source #

Property "MinValue" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "MinValue" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "MinValue" Parameter = Integer

Methods

set :: PropertyType "MinValue" Parameter -> Parameter -> Parameter Source #

Property "Name" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "Name" Parameter 
Instance details

Defined in Stratosphere.Parameter

Property "NoEcho" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "NoEcho" Parameter 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "NoEcho" Parameter = Bool
Property "Type" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type PropertyType "Type" Parameter 
Instance details

Defined in Stratosphere.Parameter

ToRef Parameter b Source # 
Instance details

Defined in Stratosphere.Parameter

Methods

toRef :: Parameter -> Value b Source #

type PropertyType "AllowedPattern" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "AllowedPattern" Parameter = Text
type PropertyType "AllowedValues" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "AllowedValues" Parameter = Array
type PropertyType "ConstraintDescription" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "ConstraintDescription" Parameter = Text
type PropertyType "Default" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "Default" Parameter = Value
type PropertyType "Description" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "Description" Parameter = Text
type PropertyType "MaxLength" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "MaxLength" Parameter = Integer
type PropertyType "MaxValue" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "MaxValue" Parameter = Integer
type PropertyType "MinLength" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "MinLength" Parameter = Integer
type PropertyType "MinValue" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "MinValue" Parameter = Integer
type PropertyType "Name" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "NoEcho" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

type PropertyType "NoEcho" Parameter = Bool
type PropertyType "Type" Parameter Source # 
Instance details

Defined in Stratosphere.Parameter

mkParameter 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 

Instances

Instances details
ToJSON Parameters Source # 
Instance details

Defined in Stratosphere.Parameter

Monoid Parameters Source # 
Instance details

Defined in Stratosphere.Parameter

Semigroup Parameters Source # 
Instance details

Defined in Stratosphere.Parameter

IsList Parameters Source # 
Instance details

Defined in Stratosphere.Parameter

Associated Types

type Item Parameters 
Instance details

Defined in Stratosphere.Parameter

Show Parameters Source # 
Instance details

Defined in Stratosphere.Parameter

Eq Parameters Source # 
Instance details

Defined in Stratosphere.Parameter

MonoFunctor Parameters Source # 
Instance details

Defined in Stratosphere.Parameter

type Item Parameters Source # 
Instance details

Defined in Stratosphere.Parameter

type Element Parameters Source # 
Instance details

Defined in Stratosphere.Parameter