Struct ParameterDefinition

pub struct ParameterDefinition {

    pub allowed_pattern: Option<String>,
    pub allowed_values: Option<Vec<String>>,
    pub constraint_description: Option<String>,
    pub default_value: Option<String>,
    pub description: Option<String>,
    pub max_length: Option<i64>,
    pub max_value: Option<i64>,
    pub min_length: Option<i64>,
    pub min_value: Option<i64>,
    pub name: String,
    pub no_echo: Option<bool>,
    pub referenced_by_resources: Vec<String>,
    pub type_: Option<String>,
}

Parameters supported by the application.

Fields

allowed_pattern: Option<String>

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

allowed_values: Option<Vec<String>>

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

constraint_description: Option<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:

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.

default_value: Option<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.

description: Option<String>

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

max_length: Option<i64>

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

max_value: Option<i64>

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

min_length: Option<i64>

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

min_value: Option<i64>

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

name: String

The name of the parameter.

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

referenced_by_resources: Vec<String>

A list of AWS SAM resources that use this parameter.

type_: Option<String>

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"].

Trait Implementations

impl Clone for ParameterDefinition

fn clone(&self) -> ParameterDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParameterDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ParameterDefinition

fn default() -> ParameterDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParameterDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ParameterDefinition

fn eq(&self, other: &ParameterDefinition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ParameterDefinition