@aws-lite/ssm NPM

Path (string) required
- Parameter path hierarchy, beginning with /
MaxResults (number)
- Limit the maximum number of items returned
NextToken (string)
- Pagination token to start the next set of results
ParameterFilters (array)
- Array of filters to limit results
Recursive (boolean)
- Retrieve all parameters within a hierarchy
WithDecryption (boolean)
- Decrypt encrypted parameter values
paginate (boolean)
- Enable automatic result pagination; use this instead of making your own individual pagination requests

Properties:

Name (string) required
- The name of the parameter, including the complete path hierarchy
Value (string) required
- Value of the parameter; can be up to 4KB by default, or 8KB if Advanced
AllowedPattern (string)
- Regular expression used to validate the parameter value
DataType (string)
- Data type for a String parameter; can be one of: text, aws:ec2:image, aws:ssm:integration
Description (string)
- Description of the parameter
KeyId (string)
- AWS KMS ID to use to encrypt the parameter
Overwrite (boolean)
- Overwrite an existing parameter (defaults to false)
Policies (array)
- Array of policies to apply; supports Expiration, ExpirationNotification, NoChangeNotification
- More details (AWS)
Tags (array)
- Array of tags, such as Key=OS,Value=macOS
- More details (AWS)
Tier (string)
- Parameter tier; can be one of: Standard, Advanced, Intelligent-Tiering
- More details (AWS)
Type (string)
- Parameter type; can be one of: String, StringList,SecureString