https://github.com/davidji99/terraform-provider-sendgrid

Terraform Provider Sendgrid
https://github.com/davidji99/terraform-provider-sendgrid

sendgrid sendgrid-api terraform-provider-sendgrid

Last synced: 16 days ago
JSON representation

Terraform Provider Sendgrid

• Host: GitHub
• URL: https://github.com/davidji99/terraform-provider-sendgrid
• Owner: davidji99
• License: mpl-2.0
• Created: 2021-02-14T00:44:25.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-16T12:57:27.000Z (over 1 year ago)
• Last Synced: 2024-10-12T04:45:33.538Z (about 1 month ago)
• Topics: sendgrid, sendgrid-api, terraform-provider-sendgrid
• Language: Go
• Homepage: https://registry.terraform.io/providers/davidji99/sendgrid/latest
• Size: 216 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Terraform Provider Sendgrid

=========================

The Sendgrid provider is used to interact with the resources provided by [Sendgrid V3 API](https://sendgrid.com/docs/api-reference/)

and needs to be configured with credentials before it can be used.

Requirements

------------

- [Terraform](https://www.terraform.io/downloads.html) `v0.12.x`+

- [Go](https://golang.org/doc/install) 1.14 (to build the provider plugin)

Usage

-----

```hcl

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](http://www.golang.org) 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.

```shell script

$ 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:

```sh

cp $GOPATH/bin/terraform-provider-sendgrid ~/.terraform.d/plugins/

```

Set the sendgrid provider without a version constraint:

```hcl

provider "sendgrid" {}

```

Then, initialize Terraform:

```shell script

terraform init

```

### Testing

Please see the [TESTING](TESTING.md) guide for detailed instructions on running tests.

### Updating or adding dependencies

This project uses [Go Modules](https://github.com/golang/go/wiki/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.