Optional
Readonly
allowed- No constraints on patterns allowed for parameter.
Optional
Readonly
allowedAn array containing the list of values allowed for the parameter.
- No constraints on values allowed for parameter.
Optional
Readonly
constraintA 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:
- No description with customized error message when user specifies invalid values.
Optional
Readonly
defaultA 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.
- No default value for parameter.
Optional
Readonly
descriptionA string of up to 4000 characters that describes the parameter.
- No description for the parameter.
Optional
fromSSMOptional
Readonly
maxAn integer value that determines the largest number of characters you want to allow for String types.
- None.
Optional
Readonly
maxA numeric value that determines the largest numeric value you want to allow for Number types.
- None.
Optional
Readonly
minAn integer value that determines the smallest number of characters you want to allow for String types.
- None.
Optional
Readonly
minA numeric value that determines the smallest numeric value you want to allow for Number types.
- None.
Optional
Readonly
noWhether to mask the parameter value when anyone makes a call that describes the stack.
If you set the value to true
, the parameter value is masked with asterisks (*****
).
- Parameter values are not masked.
Optional
Readonly
typeThe data type for the parameter (DataType).
String
Generated using TypeDoc
A regular expression that represents the patterns to allow for String types.