# aws-cicd-key-rotator

> Key rotation manager for AWS and your CICD tool of choice

Latest version **2.0.1** (published 2018-07-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install aws-cicd-key-rotator
pnpm add aws-cicd-key-rotator
yarn add aws-cicd-key-rotator
bun add aws-cicd-key-rotator
```

## 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 | 2.0.1 |
| Published | 2018-07-19 |
| First published | 2018-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 126.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Kyle Pitzen |
| Maintainers | kpitzen |

## Links

- npm: https://www.npmjs.com/package/aws-cicd-key-rotator
- Repository: https://github.com/kpitzen-io/aws-cicd-key-rotator
- Homepage: https://github.com/kpitzen-io/aws-cicd-key-rotator#readme
- Issues: https://github.com/kpitzen-io/aws-cicd-key-rotator/issues
- npm.io page: https://npm.io/package/aws-cicd-key-rotator

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.1.2

## Recent versions

- 2.0.1 (latest) — 2018-07-19
- 2.0.0 — 2018-07-19

## README

# aws-cicd-key-rotator

This project could probably use a better name.  We'll stick with this for now.

To use this, you will need an AWS account, a GitLab account (specifically, a group on GitLab), and a User who is allowed to do things in AWS on GitLab's behalf (specific permissions for that user coming soon (tm)).

To start, you'll need to add a project level variable for this project named <code>AWS_USER</code>.

Following this, you'll need to add variables at the repo level where you're hosting this project:

<code>
    variable "gitlab_group_id" {}

    variable "api_key" {}

    variable "aws_user" {}

    variable "cicd_stack" {
    default = "GitLab"

    description = "The CICD Stack being used.  We currently support: GitLab"
    }
</code>

You'll also need to change the backend from <code>kpitzen-ci</code> to whichever s3 bucket you're using as a backend for terraform.

From there, GitLab should handle the rest - it'll create the lambda to rotate your keys and associate with it a role to do so in IAM.

Alternately, the cloudwatch automation can be skipped by removing it from terraform, or just manually deploying the lambda itself.  That lambda can then be invoke with an input body of the form:
<code>
{
    groupId: //groupId,
    apiKey: //apiKey,
    awsUser: //awsUser
}
</code>

More stacks are planned, so stay tuned!

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