interface CfnParameterProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnParameterProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2#CfnParameterProps |
 Java | software.amazon.awscdk.CfnParameterProps |
 Python | aws_cdk.CfnParameterProps |
 TypeScript (source) | aws-cdk-lib » CfnParameterProps |
Example
new CfnParameter(this, 'MyParameter', {
type: 'Number',
default: 1337,
// See the API reference for more configuration props
});
Properties
| Name | Type | Description |
|---|---|---|
| allowed | string | A regular expression that represents the patterns to allow for String types. |
| allowed | string[] | An array containing the list of values allowed for the parameter. |
| constraint | string | A string that explains a constraint when the constraint is violated. |
| default? | any | A value of the appropriate type for the template to use if no value is specified when a stack is created. |
| description? | string | A string of up to 4000 characters that describes the parameter. |
| max | number | An integer value that determines the largest number of characters you want to allow for String types. |
| max | number | A numeric value that determines the largest numeric value you want to allow for Number types. |
| min | number | An integer value that determines the smallest number of characters you want to allow for String types. |
| min | number | A numeric value that determines the smallest numeric value you want to allow for Number types. |
| no | boolean | Whether to mask the parameter value when anyone makes a call that describes the stack. |
| type? | string | The data type for the parameter (DataType). |
allowedPattern?
Type:
string
(optional, default: No constraints on patterns allowed for parameter.)
A regular expression that represents the patterns to allow for String types.
allowedValues?
Type:
string[]
(optional, default: No constraints on values allowed for parameter.)
An array containing the list of values allowed for the parameter.
constraintDescription?
Type:
string
(optional, default: No description with customized error message when user specifies invalid values.)
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?
Type:
any
(optional, default: No default value for parameter.)
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?
Type:
string
(optional, default: No description for the parameter.)
A string of up to 4000 characters that describes the parameter.
maxLength?
Type:
number
(optional, default: None.)
An integer value that determines the largest number of characters you want to allow for String types.
maxValue?
Type:
number
(optional, default: None.)
A numeric value that determines the largest numeric value you want to allow for Number types.
minLength?
Type:
number
(optional, default: None.)
An integer value that determines the smallest number of characters you want to allow for String types.
minValue?
Type:
number
(optional, default: None.)
A numeric value that determines the smallest numeric value you want to allow for Number types.
noEcho?
Type:
boolean
(optional, default: Parameter values are not masked.)
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 (*****).
type?
Type:
string
(optional, default: String)
The data type for the parameter (DataType).