JSPM

  • Created
  • Published
  • Downloads 128
  • Score
    100M100P100Q58294F
  • License MIT

Terraform Cloud API wrapper

Package Exports

  • terraform-cloud

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (terraform-cloud) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

terraform-cloud

@latest Build Status Maintainability Test Coverage Try terraform-cloud on RunKit

Terraform Cloud REST API client for javascript.

NOTE: This is a work in progress, please review the current implementation.

Instalation

yarn add terraform-cloud # With Yarn
npm install terraform-cloud # With NPM

Usage

import { TerraformCloud } from 'terraform-cloud'

// Set a your terraform cloud API token
const { Account, Plans, Runs } = new TerraformCloud('terraform-api-token')

// Make an API call

// Get Account Information
Account.getDetails().then(account => {
  // handle account data
})

// Update Account Password
const updatePasswordRequest = {
  data: {
    type: 'user',
    attributes: {
      current_password: 'current-password',
      password: 'new-password',
      password_confirmation: 'new-password',
    },
  },
}

Account.updatePassword(updatePasswordRequest).then(user => {
  // handle account password update
})

Plans.show('plan-id').then(plan => {
  // handle plan data
})

// Runs

Runs.show('run-id').then(run => {
  // handle run data
})

// Perform an action over a run ex: (apply, cancel, discard, force-cancel, force-execute)
Runs.action('cancel', 'run-id', { data: { comment: 'cancel run by id' } }).then(() => {
  // handle run action
})

Current implementation

TODO

  • Workspaces
  • ...

Contributing

We would love you to contribute to terraform-cloud, pull requests are very welcome! Please see CONTRIBUTING.md for more information.

LICENSE

MIT