AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

StringListParameter

Creates a new StringList SSM Parameter.

Import

import { StringListParameter } from 'aws-cdk-lib/aws-ssm';

Or use the module namespace:

import * as ssm from 'aws-cdk-lib/aws-ssm';
// ssm.StringListParameter

Properties

Configuration passed to the constructor as StringListParameterProps.

stringListValueRequired
string[]

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

5 properties inherited from ParameterOptions
allowedPatternOptionalinherited from ParameterOptions
string

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+$``

Default: no validation is performed

descriptionOptionalinherited from ParameterOptions
string

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

Default: none

parameterNameOptionalinherited from ParameterOptions
string

The name of the parameter.

Default: - a name will be generated by CloudFormation

simpleNameOptionalinherited from ParameterOptions
boolean

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.

Default: - auto-detect based on `parameterName`

tierOptionalinherited from ParameterOptions
ParameterTier

The 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 Newsletter