Metadata-Version: 2.1
Name: sceptre-ssm-resolver
Version: 1.2.1
Summary: A Sceptre resolver to retrieve data from the AWS secure store
Home-page: https://github.com/sceptre/sceptre-ssm-resolver
Author: zaro0508
Author-email: zaro0508@gmail.com
License: Apache2
Keywords: sceptre,sceptre-resolver
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: packaging (==16.8)
Provides-Extra: test
Requires-Dist: pytest (>=3.2) ; extra == 'test'

# 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:
  <name>: !ssm /prefix/param
```

```yaml
parameter|sceptre_user_data:
  <name>: !ssm
    name: /prefix/param
    region: us-east-1
    profile: OtherAccount
```

```yaml
parameter|sceptre_user_data:
  <name>: !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
```


