interface StringParameterProps

Language	Type name
.NET	Amazon.CDK.AWS.SSM.StringParameterProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsssm#StringParameterProps
Java	software.amazon.awscdk.services.ssm.StringParameterProps
Python	aws_cdk.aws_ssm.StringParameterProps
TypeScript (source)	aws-cdk-lib » aws_ssm » StringParameterProps

Properties needed to create a String SSM parameter.

Example

import * as lambda from 'aws-cdk-lib/aws-lambda';

const simpleParameter = new ssm.StringParameter(this, 'StringParameter', {
  // the parameter name doesn't contain any '/'
  parameterName: 'parameter',
  stringValue: 'SOME_VALUE',
  simpleName: true, // set `simpleName` to true
});

declare const func: lambda.IFunction;
const nonSimpleParameter = new ssm.StringParameter(this, 'StringParameter', {
  // the parameter name contains '/'
  parameterName: `/${func.functionName}/my/app/param`,
  stringValue: 'SOME_VALUE',
  simpleName: false, // set `simpleName` to false
});

Properties

Name	Type	Description
stringValue	string	The value of the parameter.
allowedPattern?	string	A regular expression used to validate the parameter value.
dataType?	ParameterDataType	The data type of the parameter, such as text or aws:ec2:image.
description?	string	Information about the parameter that you want to add to the system.
parameterName?	string	The name of the parameter.
simpleName?	boolean	Indicates whether the parameter name is a simple name.
tier?	ParameterTier	The tier of the string parameter.
type?⚠️	ParameterType	The type of the string parameter.

---

stringValue

Type: string

The value of the parameter.

It may not reference another parameter and {{}} cannot be used in the value.

---

allowedPattern?

Type: string (optional, default: no validation is performed)

A regular expression used to validate the parameter value.

For example, for String types with values restricted to numbers, you can specify the following: ^\d+$

---

dataType?

Type: ParameterDataType (optional, default: ParameterDataType.TEXT)

The data type of the parameter, such as text or aws:ec2:image.

---

description?

Type: string (optional, default: none)

Information about the parameter that you want to add to the system.

---

parameterName?

Type: string (optional, default: a name will be generated by CloudFormation)

The name of the parameter.

---

simpleName?

Type: boolean (optional, default: auto-detect based on parameterName)

Indicates 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.

---

tier?

Type: ParameterTier (optional, default: undefined)

The tier of the string parameter.

---

type?⚠️

⚠️ Deprecated: - type will always be 'String'

Type: ParameterType (optional, default: ParameterType.STRING)

The type of the string parameter.