interface StringListParameterProps

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

Properties needed to create a StringList SSM Parameter.

Example

// Create a new SSM Parameter holding a String
const param = new ssm.StringParameter(this, 'StringParameter', {
  // description: 'Some user-friendly description',
  // name: 'ParameterName',
  stringValue: 'Initial parameter value',
  // allowedPattern: '.*',
});

// Grant read access to some Role
declare const role: iam.IRole;
param.grantRead(role);

// Create a new SSM Parameter holding a StringList
const listParameter = new ssm.StringListParameter(this, 'StringListParameter', {
  // description: 'Some user-friendly description',
  // name: 'ParameterName',
  stringListValue: ['Initial parameter value A', 'Initial parameter value B'],
  // allowedPattern: '.*',
});

Properties

Name	Type	Description
stringListValue	string[]	The values of the parameter.
allowedPattern?	string	A regular expression used to validate the parameter value.
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.

---

stringListValue

Type: string[]

The values 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+$

---

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.