ParameterDefinition class
Parameters supported by the application.
Constructors
-
ParameterDefinition({required String name, required List<
String> referencedByResources, String? allowedPattern, List<String> ? allowedValues, String? constraintDescription, String? defaultValue, String? description, int? maxLength, int? maxValue, int? minLength, int? minValue, bool? noEcho, String? type}) -
ParameterDefinition.fromJson(Map<
String, dynamic> json) -
factory
Properties
- allowedPattern → String?
-
A regular expression that represents the patterns to allow for String types.
final
-
allowedValues
→ List<
String> ? -
An array containing the list of values allowed for the parameter.
final
- constraintDescription → String?
-
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:final - defaultValue → String?
-
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.
final
- description → String?
-
A string of up to 4,000 characters that describes the parameter.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxLength → int?
-
An integer value that determines the largest number of characters that you
want to allow for String types.
final
- maxValue → int?
-
A numeric value that determines the largest numeric value that you want to
allow for Number types.
final
- minLength → int?
-
An integer value that determines the smallest number of characters that you
want to allow for String types.
final
- minValue → int?
-
A numeric value that determines the smallest numeric value that you want to
allow for Number types.
final
- name → String
-
The name of the parameter.
final
- noEcho → 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 (*****).
final
-
referencedByResources
→ List<
String> -
A list of AWS SAM resources that use this parameter.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → String?
-
The type of the parameter.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited