NAME

Paws::ServerlessRepo::ParameterDefinition

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::ServerlessRepo::ParameterDefinition object:

  $service_obj->Method(Att1 => { AllowedPattern => $value, ..., Type => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ServerlessRepo::ParameterDefinition object:

  $result = $service_obj->Method(...);
  $result->Att1->AllowedPattern

DESCRIPTION

Parameters supported by the application.

ATTRIBUTES

AllowedPattern => Str

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

AllowedValues => ArrayRef[Str|Undef]

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

ConstraintDescription => Str

  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.

DefaultValue => Str

  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.

Description => Str

  A string of up to 4,000 characters that describes the parameter.

MaxLength => Int

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

MaxValue => Int

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

MinLength => Int

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

MinValue => Int

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

REQUIRED Name => Str

  The name of the parameter.

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

REQUIRED ReferencedByResources => ArrayRef[Str|Undef]

  A list of AWS SAM resources that use this parameter.

Type => Str

  The type of the parameter.

Valid values: String | Number | List<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<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"].

SEE ALSO

This class forms part of Paws, describing an object used in Paws::ServerlessRepo

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues