Official aws-lite
plugin for SSM
Maintained by: @architect
Install
npm i @aws-lite/ssm
Optionally install types:
npm i -D @aws-lite/ssm-types
Reference
Reference documentation with examples at aws-lite.org
Methods
DeleteParameter
Canonical AWS API doc
Properties:
Name
(string) [required]
- The name of the parameter
DeleteParameters
Canonical AWS API doc
Properties:
Names
(array) [required]
- Array of parameter names to delete
GetParameter
Canonical AWS API doc
Properties:
Name
(string) [required]
- The name of the parameter
WithDecryption
(boolean)
- Decrypt encrypted parameter values
GetParameters
Canonical AWS API doc
Properties:
Names
(array) [required]
- Array of parameter names to query
WithDecryption
(boolean)
- Decrypt encrypted parameter values
GetParametersByPath
Canonical AWS API doc
Properties:
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
PutParameter
Canonical AWS API doc
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)
Tier
(string)
Type
(string)
- Parameter type; can be one of:
String
, StringList
,SecureString
Methods yet to be implemented
Please help out by opening a PR!
Learn more