AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Parameters supported by the application.

Inheritance Hierarchy

System.Object
  Amazon.ServerlessApplicationRepository.Model.ParameterDefinition

Namespace: Amazon.ServerlessApplicationRepository.Model
Assembly: AWSSDK.ServerlessApplicationRepository.dll
Version: 3.x.y.z

Syntax

C#
public class ParameterDefinition

The ParameterDefinition type exposes the following members

Constructors

NameDescription
Public Method ParameterDefinition()

Properties

NameTypeDescription
Public Property AllowedPattern System.String

Gets and sets the property AllowedPattern.

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

Public Property AllowedValues System.Collections.Generic.List<System.String>

Gets and sets the property AllowedValues.

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

Public Property ConstraintDescription System.String

Gets and sets the property 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 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.

Public Property DefaultValue System.String

Gets and sets the property DefaultValue.

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.

Public Property Description System.String

Gets and sets the property Description.

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

Public Property MaxLength System.Int32

Gets and sets the property MaxLength.

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

Public Property MaxValue System.Int32

Gets and sets the property MaxValue.

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

Public Property MinLength System.Int32

Gets and sets the property MinLength.

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

Public Property MinValue System.Int32

Gets and sets the property MinValue.

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

Public Property Name System.String

Gets and sets the property Name.

The name of the parameter.

Public Property NoEcho System.Boolean

Gets and sets the property NoEcho.

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

Public Property ReferencedByResources System.Collections.Generic.List<System.String>

Gets and sets the property ReferencedByResources.

A list of AWS SAM resources that use this parameter.

Public Property Type System.String

Gets and sets the property Type.

The type of the parameter.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms