# aws-install

> Tools for creating installer-like [Node.js](https://nodejs.org) apps for launching infrastructure on [AWS](https://aws.amazon.com) with [CloudFormation](https://aws.amazon.com/cloudformation)

Latest version **0.0.1** (published 2019-05-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install aws-install
pnpm add aws-install
yarn add aws-install
bun add aws-install
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2019-05-12 |
| First published | 2019-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 146.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | possibilities |

## Links

- npm: https://www.npmjs.com/package/aws-install
- npm.io page: https://npm.io/package/aws-install

## Dependencies (7)

- [ulid](https://npm.io/package/ulid.md) ^2.3.0
- [jszip](https://npm.io/package/jszip.md) ^3.2.1
- [yargs](https://npm.io/package/yargs.md) ^13.2.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [yaml-cfn](https://npm.io/package/yaml-cfn.md) ^0.2.0
- [klaw-sync](https://npm.io/package/klaw-sync.md) ^6.0.0
- [prompt-promise](https://npm.io/package/prompt-promise.md) ^1.0.3

## Recent versions

- 0.0.1 (latest) — 2019-05-12

## README

# AWS Install

Tools for creating installer-like [Node.js](https://nodejs.org) apps for launching infrastructure on [AWS](https://aws.amazon.com) with [CloudFormation](https://aws.amazon.com/cloudformation)

## Usage

See app in `./example` directory.

```Shell
cd ./example
yarn install
./example install
./example uninstall
```

## API

The following functions create high-level handlers that can be used in apps. E.g. `install`/`uninstall` command in a CLI application can drive these handlers. Returned handler interfaces are documented below.

##### `install(params = {}): InstallHandler`

`params` (Object):

* `stackName` – (boolean)

  The name of the CloudFormation stack that will be created. This field is required.

* `templatePath` – (string)

  Absolute path to CloudFormation body template. This field is required.

* `parameterSchema` – (object[])

  An array of object  describing parameters that the handler should pass into the CloudFormation template as [Parameters](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html).

  Each parameter schema must have the following keys

  * `templateName`

    The name of the parameter as it will appear in the CloudFormation template.

  * `argumentName`

    The name of the parameter as it will be passed into the handler

* `logger` – (object)

  A logger that the handler will use for displaying activity.

  The object must support the following subset of the `console` API

  * `info`

  * `group`

  * `groupBy`

##### `uninstall(params = {}): UninstallHandler`

* `stackName` – (boolean)

  The name of the CloudFormation stack that will be deleted. This field is required.

### Interfaces

##### `InstallHandler`

TODO

##### `UninstallHandler`

TODO

---
_Source: https://npm.io/package/aws-install · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
