interface ListParameterAttributes

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

Attributes for parameters of string list type.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
const listParameterAttributes: ssm.ListParameterAttributes = {
  parameterName: 'parameterName',

  // the properties below are optional
  elementType: ssm.ParameterValueType.STRING,
  simpleName: false,
  version: 123,
};

Properties

Name	Type	Description
parameterName	`string`	The name of the parameter store value.
elementType?	`ParameterValueType`	The type of the string list parameter value.
simpleName?	`boolean`	Indicates whether the parameter name is a simple name.
version?	`number`	The version number of the value you wish to retrieve.

parameterName

Type: string

The name of the parameter store value.

This value can be a token or a concrete string. If it is a concrete string and includes "/" it must also be prefixed with a "/" (fully-qualified).

elementType?

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

The type of the string list parameter value.

Using specific types can be helpful in catching invalid values at the start of creating or updating a stack. CloudFormation validates the values against existing values in the account.

Note - if you want to allow values from different AWS accounts, use ParameterValueType.STRING

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.

version?

Type: number (optional, default: The latest version will be retrieved.)

The version number of the value you wish to retrieve.