AWS CDK Reference

Appearance

v2.275.0

ListParameterAttributes Struct ​

Attributes for parameters of string list type.

Source
aws-ssm/lib/parameter.ts
Type last changed
v2.42.0 · 16 Sep 2022

Example ​

ts
// 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 ​

elementTypeoptionalParameterValueTypeelement_typeoptionalParameterValueTypeelementTypeoptionalParameterValueTypeElementTypeoptionalParameterValueTypeElementTypeoptionalParameterValueType= ParameterValueType.STRING#
The type of the string list parameter value.
notes

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

parameterNamestringparameter_namestrparameterNameStringParameterNamestringParameterName*stringrequired#
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).

simpleNameoptionalbooleansimple_nameoptionalboolsimpleNameoptionalBooleanSimpleNameoptionalboolSimpleNameoptional*bool#
Indicates whether the parameter name is a simple name.

Default: auto-detect based on parameterName

notes

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.

versionoptionalnumberversionoptionalint | floatversionoptionalNumberVersionoptionaldoubleVersionoptional*float64#
The version number of the value you wish to retrieve.

Default: The latest version will be retrieved.