Struct aws_sdk_serverlessapplicationrepository::model::ParameterDefinition

#[non_exhaustive]
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: i32,
    pub max_value: i32,
    pub min_length: i32,
    pub min_value: i32,
    pub name: Option<String>,
    pub no_echo: bool,
    pub referenced_by_resources: Option<Vec<String>>,
    pub type: Option<String>,
}

Parameters supported by the application.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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: i32

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

max_value: i32

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

min_length: i32

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

min_value: i32

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

name: Option<String>

The name of the parameter.

no_echo: 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: Option<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"].

Implementations

impl ParameterDefinition

pub fn allowed_pattern(&self) -> Option<&str>

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

pub fn allowed_values(&self) -> Option<&[String]>

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

pub fn constraint_description(&self) -> Option<&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.

pub fn default_value(&self) -> Option<&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.

pub fn description(&self) -> Option<&str>

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

pub fn max_length(&self) -> i32

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

pub fn max_value(&self) -> i32

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

pub fn min_length(&self) -> i32

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

pub fn min_value(&self) -> i32

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

pub fn name(&self) -> Option<&str>

The name of the parameter.

pub fn no_echo(&self) -> 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 (*****).

pub fn referenced_by_resources(&self) -> Option<&[String]>

A list of AWS SAM resources that use this parameter.

pub fn type(&self) -> Option<&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"].

impl ParameterDefinition

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ParameterDefinition

Trait Implementations

impl Clone for ParameterDefinition

fn clone(&self) -> ParameterDefinition

Returns a copy 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 PartialEq<ParameterDefinition> for ParameterDefinition

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ParameterDefinition