# README
Terraform Provider Sendgrid
The Sendgrid provider is used to interact with the resources provided by Sendgrid V3 API and needs to be configured with credentials before it can be used.
Requirements
Usage
provider "sendgrid" {
version = "~> 0.1.0"
}
This provider is not compatible with terraform v0.11.x
.
Development
If you wish to work on the provider, you'll first need Go installed on your machine (version 1.14+ is required).
Build the Provider
To compile the provider, run make build
. This will build the provider and put the provider binary in the $GOPATH/bin
directory.
$ make build
...
$ $GOPATH/bin/terraform-provider-sendgrid
...
Using the Provider
To use the dev provider with local Terraform, copy the freshly built plugin into Terraform's local plugins directory:
cp $GOPATH/bin/terraform-provider-sendgrid ~/.terraform.d/plugins/
Set the sendgrid provider without a version constraint:
provider "sendgrid" {}
Then, initialize Terraform:
terraform init
Testing
Please see the TESTING guide for detailed instructions on running tests.
Updating or adding dependencies
This project uses Go Modules for dependency management.
This example will fetch a module at the release tag and record it in your project's go.mod
and go.sum
files.
It's a good idea to run go mod tidy
afterward and then go mod vendor
to copy the dependencies into a vendor/
directory.
If a module does not have release tags, then module@SHA
can be used instead.