# serverless-cf-parameters

> Serverless's plugin to configure CloudFormation Parameters

Latest version **1.1.1** (published 2020-06-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install serverless-cf-parameters
pnpm add serverless-cf-parameters
yarn add serverless-cf-parameters
bun add serverless-cf-parameters
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2020-06-16 |
| First published | 2020-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Felipe Nuñez |
| Maintainers | toryas |
| Keywords | serverless, cf, cloudformation, parameters, aws |

## Links

- npm: https://www.npmjs.com/package/serverless-cf-parameters
- Repository: https://github.com/toryas/serverless-cf-parameters
- Homepage: https://github.com/toryas/serverless-cf-parameters#readme
- Issues: https://github.com/toryas/serverless-cf-parameters/issues
- npm.io page: https://npm.io/package/serverless-cf-parameters

## Dependencies (1)

- [inquirer](https://npm.io/package/inquirer.md) ^7.2.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2020-06-16
- 1.1.0 — 2020-06-16
- 1.0.0 — 2020-06-16

## README

# Serverless CF Parameters

Serverless plugin to set CloudFormation Parameters.

## Install

1. run `npm install --sade-dev serverless-cf-parameters`
2. add **serverless-cf-parameters** in serverless.yml plugin section
    ```yml
    plugins:
        - serverless-cf-parameters
    ```

Whit this plugin you have 2 ways to set Parameters.

## Interactive mode

When you run deploy or package, the plugin find Parameters in `resources` section from `serverless.yml` file. 

Then then plugin ask for these parameters to define the values ​​for them.

<img src="https://github.com/toryas/serverless-cf-parameters/blob/master/docs/gif/interactive-mode.gif?raw=true">

## Parameters in JSON

When you run deploy or package pass `--cf-parameters` flag and the JOSN path with the values for parameters.

<img src="https://github.com/toryas/serverless-cf-parameters/blob/master/docs/gif/json-mode.gif?raw=true">

an example:

this is your serverless.yml

```yml
#...

resources:
    Parameters:
        MyParameter:
            Type: String
            MinLength: 3
            MaxLength: 63
            AllowedPattern: "([a-zA-Z0-9]){1}([a-zA-Z0-9-])*"
        OtherParameter:
            Type: String
            MinLength: 3
            MaxLength: 63
            AllowedPattern: "([a-zA-Z0-9]){1}([a-zA-Z0-9-])*"

#...

```

your json file with parameters config looks like this:

```json
{
    "MyParameter":"value for MyParameter",
    "OtherParameter":"value for OtherParameter"
}
```

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