https://github.com/sceptre/sceptre-ssm-resolver
A Sceptre resolver to retrieve values from the AWS SSM
https://github.com/sceptre/sceptre-ssm-resolver
sceptre sceptre-resolver
Last synced: 10 days ago
JSON representation
A Sceptre resolver to retrieve values from the AWS SSM
- Host: GitHub
- URL: https://github.com/sceptre/sceptre-ssm-resolver
- Owner: Sceptre
- Created: 2019-09-19T18:36:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T16:32:53.000Z (16 days ago)
- Last Synced: 2025-04-07T17:38:40.438Z (15 days ago)
- Topics: sceptre, sceptre-resolver
- Language: Python
- Size: 60.5 KB
- Stars: 8
- Watchers: 10
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Overview
The purpose of this resolver is to retrieve values from the AWS SSM.
## Install
```bash
pip install sceptre-ssm-resolver
```
## Available Resolvers
### ssm
Fetches the value stored in AWS SSM Parameter Store.
__Note:__ Sceptre must be run with a user or role that has access to the parameter store
Syntax:
```yaml
parameter|sceptre_user_data:
: !ssm /prefix/param
```
```yaml
parameter|sceptre_user_data:
: !ssm
name: /prefix/param
region: us-east-1
profile: OtherAccount
```
```yaml
parameter|sceptre_user_data:
: !ssm {"name": "/prefix/param", "region": "us-east-1", "profile": "OtherAccount"}
```
#### Parameters
* name - SSM key name, mandatory
* region - SSM key region, optional, stack region by default
* profile - SSM key's account profile , optional, stack profile by default
#### Example:
Add a secure string to the SSM parameter store
```bash
aws ssm put-parameter --name /dev/DbPassword --value "mysecret" \
--key-id alias/dev/kmskey --type "SecureString"
```
Retrieve and decrypt SSM parameter from the same account that the
stack is being deployed to:
```yaml
parameters:
database_password: !ssm /dev/DbPassword
```
Retrieve and decrypt SSM parameter from another AWS account:
```yaml
parameters:
database_password: !ssm
name: /dev/DbPassword
profile: OtherAccount
```