Struct aws_sdk_serverlessapplicationrepository::model::parameter_definition::Builder

#[non_exhaustive]
pub struct Builder { /* fields omitted */ }

A builder for ParameterDefinition

Implementations

impl Builder

pub fn allowed_pattern(self, input: impl Into<String>) -> Self

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

pub fn set_allowed_pattern(self, input: Option<String>) -> Self

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

pub fn allowed_values(self, input: impl Into<String>) -> Self

Appends an item to allowed_values.

To override the contents of this collection use set_allowed_values.

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

pub fn set_allowed_values(self, input: Option<Vec<String>>) -> Self

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

pub fn constraint_description(self, input: impl Into<String>) -> Self

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 set_constraint_description(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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 set_default_value(self, input: Option<String>) -> Self

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, input: impl Into<String>) -> Self

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

pub fn set_description(self, input: Option<String>) -> Self

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

pub fn max_length(self, input: i32) -> Self

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

pub fn set_max_length(self, input: Option<i32>) -> Self

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

pub fn max_value(self, input: i32) -> Self

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

pub fn set_max_value(self, input: Option<i32>) -> Self

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

pub fn min_length(self, input: i32) -> Self

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

pub fn set_min_length(self, input: Option<i32>) -> Self

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

pub fn min_value(self, input: i32) -> Self

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

pub fn set_min_value(self, input: Option<i32>) -> Self

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

pub fn name(self, input: impl Into<String>) -> Self

The name of the parameter.

pub fn set_name(self, input: Option<String>) -> Self

The name of the parameter.

pub fn no_echo(self, input: bool) -> Self

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 set_no_echo(self, input: Option<bool>) -> Self

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, input: impl Into<String>) -> Self

Appends an item to referenced_by_resources.

To override the contents of this collection use set_referenced_by_resources.

A list of AWS SAM resources that use this parameter.

pub fn set_referenced_by_resources(self, input: Option<Vec<String>>) -> Self

A list of AWS SAM resources that use this parameter.

pub fn type(self, input: impl Into<String>) -> Self

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

pub fn set_type(self, input: Option<String>) -> Self

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

pub fn build(self) -> ParameterDefinition

Consumes the builder and constructs a ParameterDefinition

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder