Amazonka.ServiceCatalog.Types.ParameterConstraints

Documentation

data ParameterConstraints

The constraints that the administrator has put on the parameter.

See: newParameterConstraints smart constructor.

Constructors

ParameterConstraints'

Fields

• allowedPattern :: Maybe Text

  A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

• allowedValues :: Maybe [Text]

  The values that the administrator has allowed for the parameter.

• constraintDescription :: Maybe Text

  A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

  Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

  By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

  Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

• maxLength :: Maybe Text

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

• maxValue :: Maybe Text

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

• minLength :: Maybe Text

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

• minValue :: Maybe Text

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

Instances

FromJSON ParameterConstraints

Defined in Amazonka.ServiceCatalog.Types.ParameterConstraints

Methods

parseJSON :: Value -> Parser ParameterConstraints

parseJSONList :: Value -> Parser [ParameterConstraints]

Generic ParameterConstraints

Defined in Amazonka.ServiceCatalog.Types.ParameterConstraints

Associated Types

type Rep ParameterConstraints :: Type -> Type

Methods

from :: ParameterConstraints -> Rep ParameterConstraints x

to :: Rep ParameterConstraints x -> ParameterConstraints

Read ParameterConstraints

Defined in Amazonka.ServiceCatalog.Types.ParameterConstraints

Methods

readsPrec :: Int -> ReadS ParameterConstraints

readList :: ReadS [ParameterConstraints]

readPrec :: ReadPrec ParameterConstraints

readListPrec :: ReadPrec [ParameterConstraints]

Show ParameterConstraints

Defined in Amazonka.ServiceCatalog.Types.ParameterConstraints

Methods

showsPrec :: Int -> ParameterConstraints -> ShowS

show :: ParameterConstraints -> String

showList :: [ParameterConstraints] -> ShowS

NFData ParameterConstraints

Defined in Amazonka.ServiceCatalog.Types.ParameterConstraints

Methods

rnf :: ParameterConstraints -> ()

Eq ParameterConstraints

Defined in Amazonka.ServiceCatalog.Types.ParameterConstraints

Methods

(==) :: ParameterConstraints -> ParameterConstraints -> Bool

(/=) :: ParameterConstraints -> ParameterConstraints -> Bool

Hashable ParameterConstraints

Defined in Amazonka.ServiceCatalog.Types.ParameterConstraints

Methods

hashWithSalt :: Int -> ParameterConstraints -> Int

hash :: ParameterConstraints -> Int

type Rep ParameterConstraints

Defined in Amazonka.ServiceCatalog.Types.ParameterConstraints

type Rep ParameterConstraints = D1 ('MetaData "ParameterConstraints" "Amazonka.ServiceCatalog.Types.ParameterConstraints" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "ParameterConstraints'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowedPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "allowedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "constraintDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "maxLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "minLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "minValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newParameterConstraints :: ParameterConstraints

Create a value of ParameterConstraints 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:allowedPattern:ParameterConstraints', parameterConstraints_allowedPattern - A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

$sel:allowedValues:ParameterConstraints', parameterConstraints_allowedValues - The values that the administrator has allowed for the parameter.

$sel:constraintDescription:ParameterConstraints', parameterConstraints_constraintDescription - A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

$sel:maxLength:ParameterConstraints', parameterConstraints_maxLength - An integer value that determines the largest number of characters you want to allow for String types.

$sel:maxValue:ParameterConstraints', parameterConstraints_maxValue - A numeric value that determines the largest numeric value you want to allow for Number types.

$sel:minLength:ParameterConstraints', parameterConstraints_minLength - An integer value that determines the smallest number of characters you want to allow for String types.

$sel:minValue:ParameterConstraints', parameterConstraints_minValue - A numeric value that determines the smallest numeric value you want to allow for Number types.

parameterConstraints_allowedPattern :: Lens' ParameterConstraints (Maybe Text)

A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

parameterConstraints_allowedValues :: Lens' ParameterConstraints (Maybe [Text])

The values that the administrator has allowed for the parameter.

parameterConstraints_constraintDescription :: Lens' ParameterConstraints (Maybe Text)

A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

parameterConstraints_maxLength :: Lens' ParameterConstraints (Maybe Text)

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

parameterConstraints_maxValue :: Lens' ParameterConstraints (Maybe Text)

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

parameterConstraints_minLength :: Lens' ParameterConstraints (Maybe Text)

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

parameterConstraints_minValue :: Lens' ParameterConstraints (Maybe Text)

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