# dm-processor-terraform

> Gets an output from terraform and returns the value

Latest version **1.1.3** (published 2020-10-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install dm-processor-terraform
pnpm add dm-processor-terraform
yarn add dm-processor-terraform
bun add dm-processor-terraform
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2020-10-30 |
| First published | 2020-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ben Force |
| Maintainers | benforce |

## Links

- npm: https://www.npmjs.com/package/dm-processor-terraform
- Repository: https://github.com/theBenForce/data-migration
- Homepage: https://data-migration.js.org/plugins/processors/dm-processor-terraform
- Issues: https://github.com/theBenForce/data-migration/issues
- npm.io page: https://npm.io/package/dm-processor-terraform

## Dependencies (1)

- [data-migration](https://npm.io/package/data-migration.md) ^2.17.0

## Recent versions

- 1.1.3 (latest) — 2020-10-30
- 1.1.2 — 2020-10-30
- 1.1.1 — 2020-10-30
- 1.1.0 — 2020-10-29

## README

# Welcome to dm-processor-terraform 👋

[![Build Status](https://github.com/theBenForce/data-migration/workflows/Release/badge.svg?branch=master)](https://github.com/theBenForce/data-migration/actions)
[![NPM Package](https://img.shields.io/npm/v/dm-processor-cf)](https://www.npmjs.com/package/dm-processor-cf)
[![Maintainability](https://api.codeclimate.com/v1/badges/89a0c1976c9b89979635/maintainability)](https://codeclimate.com/github/theBenForce/data-migration/maintainability)
[![Documentation](https://img.shields.io/badge/documentation-view-blue)](https://data-migration.js.org/)
[![Downloads/week](https://img.shields.io/npm/dw/dm-processor-terraform.svg)](https://npmjs.org/package/dm-processor-terraform)
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)

> A [Data Migration](https://www.npmjs.com/package/data-migration) processor to load values from Terraform outputs.

# Configuration

## Parameters

The Terraform processor accepts the following parameters as part of its configuration:

| Name      | Type   | Required | Description                                                                                                            |
| --------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| filename    | string | Yes      | Path to a terraform output file                                                                               |
| output     | string | Yes      | The name of the terraform output to return                                                                              |

## Sample Configuration

```typescript
import DynamoDbDriver from "dm-driver-dynamodb";
import TerraformProcessor from "dm-processor-terraform";

export default {
  defaultStage: "prod",
  migrationDirectory: "migrations",
  stages: {
    prod: {
      defaultParams: {
        region: "us-east-1",
      },
      drivers: {
        users: {
          driver: DynamoDbDriver,
          params: {
            TableName: {
              // Use this processor to get values from CloudFormation
              processor: TerraformProcessor,
              params: {
                filename: "some_output_file.terraform.json",
                output: "SomeOutputName",
              },
            },
          },
        },
      },
    },
  },
};
```

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