# cdk-iam-actions

> A Typescript library of AWS actions and condition key enums

Latest version **1.0.0** (published 2020-04-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install cdk-iam-actions
pnpm add cdk-iam-actions
yarn add cdk-iam-actions
bun add cdk-iam-actions
```

## 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 | 1.0.0 |
| Published | 2020-04-03 |
| First published | 2020-04-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Joseph Atkins-Turkish |
| Maintainers | spacerat |
| Keywords | aws, cdk |

## Links

- npm: https://www.npmjs.com/package/cdk-iam-actions
- Repository: https://github.com/spacerat/cdk-iam-actions
- Issues: https://github.com/spacerat/cdk-iam-actions/issues
- npm.io page: https://npm.io/package/cdk-iam-actions

## 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.0.0 (latest) — 2020-04-03
- 0.0.1 — 2020-04-03

## README

# CDK IAM Actions

A generated library of constants for IAM policy actions and condition keys.

## Usage

Install with NPM

```
npm install cdk-iam-actions
```

Then import and use whenever you need to build a `PolicyStatement`:

```typescript
import { Policy, Effect } from "@aws-cdk/aws-iam";

import { actions, conditions } from "cdk-iam-actions"; // Import them all
import { S3 } from "cdk-iam-actions/lib/actions"; // Or just the one you need

new PolicyStatement({
  effect: Effect.ALLOW,
  actions: [actions.S3.PUT_OBJECT, S3.LIST_BUCKET],
  conditions: {
    [conditions.S3.PREFIX]: "my-prefix"
  },
  resources: ["*"]
});
```

## Infrequently asked questions

### Why are the enum members `CAPITAL_SNAKE_CASE`? TitleCase would've been prettier _and_ closer to the actual action names!

JSII (Amazon's thing which lets you write Typescript and convert to C# / Java / Python) requires that enums are CAPITAL_SNAKE_CASE.

### Why must `import {S3} from cdk-iam-actions/lib/actions` include 'lib'?

Because I didn't understand npm packaging until it was too late. Stay tuned for a 2.0 where you don't need to `/lib`.

### Make??

`¯\_(ツ)_/¯`

### Why is X missing?

Submit an issue!

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