semvec/pypi-packages huggingface dataset:
sceptre-json-resolver 1.0.0
A Sceptre resolver to serialize and deserialize json
License: Apache-2.0
Requires Python: <4.0,>=3.9
Keywords: sceptre, sceptre-resolver

# sceptre-json-resolver

A Sceptre resolver to serialize and deserialize json.

## Motivation

There are use cases where you may want to pass in either a string
or a json object to a cloudformation or sceptre_user_data parameter.
This simple resolver can take some json and serialize it or deserialize
it before passing it into a cloudformation parameter or a
scepter_user_data parameter.

## Installation

To install directly from PyPI
```shell
pip install sceptre-json-resolver
```

To install from this git repo
```shell
pip install git+https://github.com/Sceptre/sceptre-json-resolver.git
```

## Usage/Examples

```yaml
parameters|sceptre_user_data:
  <name>: !from_json [ <string> ]

parameters|sceptre_user_data:
  <name>: !to_json [ <json object> ]
```

__NOTE__: This resolver expects a single-item list argument.

## Basic Examples

Take some json object serialize it to a string then pass it to a parameter:
```yaml
parameters:
   myparam: !to_json [{"key": "value"}]
```
__Note__: The string `'{"key": "value"}'` is passed to myparam


Take a string deserialize it to a json object then pass it to a parameter:
```yaml
sceptre_user_data:
  myparam: !from_json ['{"key": "value"}']
```
__Note__: The object `{"key": "value"}` is passed to myparam


## Nested resolver examples

These use case requires the nested resolver feature in
Sceptre version 4.1 and greater.


Load a json object from a file using the
[sceptre file resolver](https://pypi.org/project/sceptre-file-resolver/),
serialize the object to a string then pass it to a parameter:
```yaml
parameters:
  hounds: !to_json [ !file 'hounds.json' ]
```


Make a request to a REST API using the
[sceptre-request-resolver](https://pypi.org/project/sceptre-request-resolver/),
deserialize the response to a json object then pass it to a parameter:
```yaml
sceptre_user_data:
  hounds: !from_json
    - !request 'https://dog.ceo/api/breed/hound/list'
```