terraform/website/source/docs/providers/heroku/index.html.markdown

41 lines
1.1 KiB
Markdown

---
layout: "heroku"
page_title: "Provider: Heroku"
sidebar_current: "docs-heroku-index"
description: |-
The Heroku provider is used to interact with the resources supported by Heroku. The provider needs to be configured with the proper credentials before it can be used.
---
# Heroku Provider
The Heroku provider is used to interact with the
resources supported by Heroku. The provider needs to be configured
with the proper credentials before it can be used.
Use the navigation to the left to read about the available resources.
## Example Usage
```hcl
# Configure the Heroku provider
provider "heroku" {
email = "ops@company.com"
api_key = "${var.heroku_api_key}"
}
# Create a new application
resource "heroku_app" "default" {
# ...
}
```
## Argument Reference
The following arguments are supported:
* `api_key` - (Required) Heroku API token. It must be provided, but it can also
be sourced from the `HEROKU_API_KEY` environment variable.
* `email` - (Required) Email to be notified by Heroku. It must be provided, but
it can also be sourced from the `HEROKU_EMAIL` environment variable.