# antenny-cdk

> cdk constructs for antenny

Latest version **2.1.0** (published 2021-01-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install antenny-cdk
pnpm add antenny-cdk
yarn add antenny-cdk
bun add antenny-cdk
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2021-01-03 |
| First published | 2020-12-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 51.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jacob Breindel |
| Maintainers | antenny-admin |

## Links

- npm: https://www.npmjs.com/package/antenny-cdk
- Repository: https://github.com/antenny/antenny-cdk
- Homepage: https://github.com/antenny/antenny-cdk#readme
- Issues: https://github.com/antenny/antenny-cdk/issues
- npm.io page: https://npm.io/package/antenny-cdk

## Dependencies (5)

- [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) ^1.82.0
- [@aws-cdk/aws-iam](https://npm.io/package/@aws-cdk/aws-iam.md) ^1.82.0
- [@aws-cdk/aws-logs](https://npm.io/package/@aws-cdk/aws-logs.md) ^1.82.0
- [@aws-cdk/aws-lambda](https://npm.io/package/@aws-cdk/aws-lambda.md) ^1.82.0
- [@aws-cdk/custom-resources](https://npm.io/package/@aws-cdk/custom-resources.md) ^1.82.0

## Recent versions

- 2.1.0 (latest) — 2021-01-03
- 2.0.1 — 2021-01-02
- 2.0.0 — 2021-01-01
- 1.0.1 — 2020-12-29
- 1.0.0 — 2020-12-29

## README

# antenny-cdk

antenny-cdk is a cloud development kit construct library for Antenny. It provides a way to integrate Antenny into your cdk infrastructure.

## Installation

#### npm

```shell
npm install antenny-cdk --save
```

#### pip

```shell
pip install antenny-cdk
```

#### nuget

```shell
dotnet add package Antenny.Cdk
```

## Usage

To create a subscription in your aws-cdk project:

```javascript
const antenny = require('antenny-cdk');

const sub = new antenny.Subscription(this, 'Sub', {
  apiKey: '{api-key}',
  subscription: {
    name: 'example-subscription',
    customerId: '{customerId}',
    region: '{aws-region}',
    resource: {
      protocol: 'ws',
      url: 'wss://example.com'
    },
    endpoint: {
      protocol: 'http',
      url: 'https://example.com'
    }
  }
});
```

There is also a real world example included in our [sample-app](https://github.com/antenny/sample-app).

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