class Aws::ServerlessApplicationRepository::Types::ParameterDefinition

Parameters supported by the application.

@!attribute [rw] allowed_pattern

A regular expression that represents the patterns to allow for
String types.
@return [String]

@!attribute [rw] allowed_values

An array containing the list of values allowed for the parameter.
@return [Array<String>]

@!attribute [rw] constraint_description

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 contain only
uppercase and lowercase letters and numbers," you can display the
following customized error message:

Malformed input-Parameter MyParameter must contain only uppercase
and lowercase letters and numbers.
@return [String]

@!attribute [rw] default_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.
@return [String]

@!attribute [rw] description

A string of up to 4,000 characters that describes the parameter.
@return [String]

@!attribute [rw] max_length

An integer value that determines the largest number of characters
that you want to allow for String types.
@return [Integer]

@!attribute [rw] max_value

A numeric value that determines the largest numeric value that you
want to allow for Number types.
@return [Integer]

@!attribute [rw] min_length

An integer value that determines the smallest number of characters
that you want to allow for String types.
@return [Integer]

@!attribute [rw] min_value

A numeric value that determines the smallest numeric value that you
want to allow for Number types.
@return [Integer]

@!attribute [rw] name

The name of the parameter.
@return [String]

@!attribute [rw] no_echo

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 (*****).
@return [Boolean]

@!attribute [rw] referenced_by_resources

A list of AWS SAM resources that use this parameter.
@return [Array<String>]

@!attribute [rw] type

The type of the parameter.

Valid values: String \| Number \| List&lt;Number> \|
CommaDelimitedList

String: A literal string.

For example, users can specify "MyUserName".

Number: An integer or float. AWS CloudFormation validates the
parameter value as a number. However, when you use the parameter
elsewhere in your template (for example, by using the Ref intrinsic
function), the parameter value becomes a string.

For example, users might specify "8888".

List&lt;Number>: An array of integers or floats that are separated
by commas. AWS CloudFormation validates the parameter value as
numbers. However, when you use the parameter elsewhere in your
template (for example, by using the Ref intrinsic function), the
parameter value becomes a list of strings.

For example, users might specify "80,20", and then Ref results in
\["80","20"\].

CommaDelimitedList: An array of literal strings that are separated
by commas. The total number of strings should be one more than the
total number of commas. Also, each member string is space-trimmed.

For example, users might specify "test,dev,prod", and then Ref
results in \["test","dev","prod"\].
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/serverlessrepo-2017-09-08/ParameterDefinition AWS API Documentation

Constants

SENSITIVE