CfnParameterProps Struct
Example
ts
const stack = new Stack();
const durToken = new CfnParameter(stack, 'MyParameter', {
type: 'Number',
default: 60,
});
new CustomResource(stack, 'MyCustomResource', {
serviceToken: 'MyServiceToken',
serviceTimeout: Duration.seconds(durToken.valueAsNumber),
});
Properties
allowedPatternoptionalstringallowed_patternoptionalstrallowedPatternoptionalStringAllowedPatternoptionalstringAllowedPatternoptional*string#A regular expression that represents the patterns to allow for String types.
Default: No constraints on patterns allowed for parameter.
allowedValuesoptionalstring[]allowed_valuesoptionaltyping.List[str]allowedValuesoptionalList<String>AllowedValuesoptionalstring[]AllowedValuesoptional*[]*string#An array containing the list of values allowed for the parameter.
Default: No constraints on values allowed for parameter.
constraintDescriptionoptionalstringconstraint_descriptionoptionalstrconstraintDescriptionoptionalStringConstraintDescriptionoptionalstringConstraintDescriptionoptional*string#A string that explains a constraint when the constraint is violated.
Default: No description with customized error message when user specifies invalid values.
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:
defaultoptionalanydefaultoptionalAnydefaultoptionalObjectDefaultoptionalobjectDefaultoptionalinterface{}#A value of the appropriate type for the template to use if no value is specified when a stack is created.
Default: No default value for parameter.
If you define constraints for the parameter, you must specify a value that adheres to those constraints.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A string of up to 4000 characters that describes the parameter.
Default: No description for the parameter.
maxLengthoptionalnumbermax_lengthoptionalint | floatmaxLengthoptionalNumberMaxLengthoptionaldoubleMaxLengthoptional*float64= None.#An integer value that determines the largest number of characters you want to allow for String types.
maxValueoptionalnumbermax_valueoptionalint | floatmaxValueoptionalNumberMaxValueoptionaldoubleMaxValueoptional*float64= None.#A numeric value that determines the largest numeric value you want to allow for Number types.
minLengthoptionalnumbermin_lengthoptionalint | floatminLengthoptionalNumberMinLengthoptionaldoubleMinLengthoptional*float64= None.#An integer value that determines the smallest number of characters you want to allow for String types.
minValueoptionalnumbermin_valueoptionalint | floatminValueoptionalNumberMinValueoptionaldoubleMinValueoptional*float64= None.#A numeric value that determines the smallest numeric value you want to allow for Number types.
Whether to mask the parameter value when anyone makes a call that describes the stack.
Default: Parameter values are not masked.
If you set the value to true, the parameter value is masked with asterisks (*****).
The data type for the parameter (DataType).