# StringListParameter

Creates a new StringList SSM Parameter.

Extends: Construct › Resource › StringListParameter
Implements: IResource, IEncryptedResource, IParameter, IStringListParameter, IEnvironmentAware, IParameterRef, IConstruct, IDependable

- CloudFormation: [`AWS::SSM::Parameter`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-ssm-parameter.html)
- L1 type: [`CfnParameter`](/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.CfnParameter.html)
- Source: [`aws-ssm/lib/parameter.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-ssm/lib/parameter.ts#L781)
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

```ts
ssm.StringListParameter.valueForTypedListParameter(this, '/My/Public/Parameter', ssm.ParameterValueType.AWS_EC2_IMAGE_ID);
```

## Initializer

```ts
new StringListParameter(scope: Construct, id: string, props: StringListParameterProps)
```

## Construct Props

- `allowedPattern`: string — A regular expression used to validate the parameter value.

  **Default:** no validation is performed

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

- `description`: string = none — Information about the parameter that you want to add to the system.

- `parameterName`: string — The name of the parameter.

  **Default:** a name will be generated by CloudFormation

- `simpleName`: boolean — Indicates whether the parameter name is a simple name.

  **Default:** auto-detect based on `parameterName`

  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.

- `stringListValue`: string[] (required) — The values of the parameter.

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

- `tier`: [ParameterTier](/cdk/api/v2/docs/aws-cdk-lib.aws_ssm.ParameterTier.html) = undefined — The tier of the string parameter.

## Properties

- `encryptionKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — The encryption key that is used to encrypt this parameter.

  **Default:** default master key

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `parameterArn`: string — The ARN of the SSM Parameter resource.

- `parameterName`: string — The name of the SSM Parameter resource.

- `parameterRef`: [ParameterReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_ssm.ParameterReference.html) — A reference to a Parameter resource.

- `parameterType`: string — The type of the SSM Parameter resource.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

- `stringListValue`: string[] — The parameter value.

  Value must not nest another parameter. Do not use {{}} in the value. Values in the array
  cannot contain commas (``,``).

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromListParameterAttributes(scope: Construct, id: string, attrs: ListParameterAttributes): IStringListParameter` (static) — Imports an external string list parameter with name and optional version.

- `fromStringListParameterName(scope: Construct, id: string, stringListParameterName: string): IStringListParameter` (static) — Imports an external parameter of type string list.

  Returns a token and should not be parsed.

- `grantOnKey(grantee: IGrantable, ...actions: string[]): GrantOnKeyResult` — Gives permissions to a grantable entity to perform actions on the encryption key.

- `grantRead(grantee: IGrantable): Grant` — [disable-awslint:no-grants].

- `grantWrite(grantee: IGrantable): Grant` — [disable-awslint:no-grants].

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `valueForTypedListParameter(scope: Construct, parameterName: string, type?: ParameterValueType, version?: number): string[]` (static) — Returns a token that will resolve (during deployment) to the list value of an SSM StringList parameter.

  **Parameters**

  - `scope` — Some scope within a stack.
  - `parameterName` — The name of the SSM parameter.
  - `type` — the type of the SSM list parameter.
  - `version` — The parameter version (recommended in order to ensure that the value won't change during deployment).

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.