CfnParameterProps

class aws_cdk.CfnParameterProps(*, allowed_pattern=None, allowed_values=None, constraint_description=None, default=None, description=None, max_length=None, max_value=None, min_length=None, min_value=None, no_echo=None, type=None)

Bases: object

Parameters:

  • allowed_pattern (Optional[str]) – A regular expression that represents the patterns to allow for String types. Default: - No constraints on patterns allowed for parameter.

  • allowed_values (Optional[Sequence[str]]) – An array containing the list of values allowed for the parameter. Default: - No constraints on values allowed for parameter.

  • constraint_description (Optional[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: Default: - No description with customized error message when user specifies invalid values.

  • default (Any) – 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. Default: - No default value for parameter.

  • description (Optional[str]) – A string of up to 4000 characters that describes the parameter. Default: - No description for the parameter.

  • max_length (Union[int, float, None]) – An integer value that determines the largest number of characters you want to allow for String types. Default: - None.

  • max_value (Union[int, float, None]) – A numeric value that determines the largest numeric value you want to allow for Number types. Default: - None.

  • min_length (Union[int, float, None]) – An integer value that determines the smallest number of characters you want to allow for String types. Default: - None.

  • min_value (Union[int, float, None]) – A numeric value that determines the smallest numeric value you want to allow for Number types. Default: - None.

  • no_echo (Optional[bool]) – Whether to mask the parameter value when anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*****). Default: - Parameter values are not masked.

  • type (Optional[str]) – The data type for the parameter (DataType). Default: String

ExampleMetadata:

infused

Example:

CfnParameter(self, "MyParameter",
    type="Number",
    default=1337
)

Attributes

allowed_pattern

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

Default:

  • No constraints on patterns allowed for parameter.

allowed_values

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

Default:

  • No constraints on values allowed for parameter.

constraint_description

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:

Default:

  • No description with customized error message when user specifies invalid values.

default

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.

Default:

  • No default value for parameter.

description

A string of up to 4000 characters that describes the parameter.

Default:

  • No description for the parameter.

max_length

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

Default:

  • None.

max_value

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

Default:

  • None.

min_length

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

Default:

  • None.

min_value

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

Default:

  • None.

no_echo

Whether to mask the parameter value when anyone makes a call that describes the stack.

If you set the value to true, the parameter value is masked with asterisks (*****).

Default:

  • Parameter values are not masked.

type

The data type for the parameter (DataType).

Default:

String