StringParameter
Creates a new String SSM Parameter.
Import
import { StringParameter } from 'aws-cdk-lib/aws-ssm';Or use the module namespace:
import * as ssm from 'aws-cdk-lib/aws-ssm';
// ssm.StringParameterProperties
Configuration passed to the constructor as StringParameterProps.
stringValueRequiredstringThe value of the parameter. It may not reference another parameter and ``{{}}`` cannot be used in the value.
dataTypeOptionalParameterDataTypeThe data type of the parameter, such as `text` or `aws:ec2:image`.
Default: ParameterDataType.TEXT
typeOptionalDeprecatedParameterTypeThe type of the string parameter.
Default: ParameterType.STRING
Deprecated: - type will always be 'String'
5 properties inherited from ParameterOptions
allowedPatternOptionalinherited from ParameterOptionsstringA regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: ``^\d+$``
Default: no validation is performed
descriptionOptionalinherited from ParameterOptionsstringInformation about the parameter that you want to add to the system.
Default: none
parameterNameOptionalinherited from ParameterOptionsstringThe name of the parameter.
Default: - a name will be generated by CloudFormation
simpleNameOptionalinherited from ParameterOptionsbooleanIndicates whether the parameter name is a simple name. A parameter name without any "/" is considered a simple name. If the parameter name includes "/", setting simpleName to true might cause unintended issues such as duplicate "/" in the resulting ARN. This is required only if `parameterName` is a token, which means we are unable to detect if the name is simple or "path-like" for the purpose of rendering SSM parameter ARNs. If `parameterName` is not specified, `simpleName` must be `true` (or undefined) since the name generated by AWS CloudFormation is always a simple name.
Default: - auto-detect based on `parameterName`
tierOptionalinherited from ParameterOptionsParameterTierThe tier of the string parameter.
Default: - undefined
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-ssm