A Pulumi provider for managing SendGrid resources.
Project description
Pulumi SendGrid Provider
Community Provider
This is an unofficial, community-maintained Pulumi provider for SendGrid. It is not affiliated with, endorsed by, or supported by Pulumi Corporation or Twilio/SendGrid. This project is an independent effort to bring infrastructure-as-code capabilities to SendGrid using Pulumi.
- Not an official product - Created and maintained by the community
- No warranties - Provided "as-is" under the Apache 2.0 License
- Community support only - Issues and questions via GitHub
A native Pulumi provider for managing SendGrid resources.
Installation
Node.js (npm)
npm install @jdetmar/pulumi-sendgrid
Python (pip)
pip install pulumi-sendgrid
Go
go get github.com/JDetmar/pulumi-sendgrid/sdk/go/sendgrid
.NET (NuGet)
dotnet add package Community.Pulumi.Sendgrid
Configuration
| Key | Environment Variable | Required | Description |
|---|---|---|---|
sendgrid:apiKey |
SENDGRID_API_KEY |
Yes | SendGrid API key for authentication |
sendgrid:baseUrl |
— | No | API base URL (default: https://api.sendgrid.com). Use https://api.eu.sendgrid.com for EU regional subusers. |
pulumi config set sendgrid:apiKey --secret SG.xxxxx
# or
export SENDGRID_API_KEY="SG.xxxxx"
Example (TypeScript)
import * as sendgrid from "@jdetmar/pulumi-sendgrid";
const apiKey = new sendgrid.ApiKey("myApiKey", {
name: "my-app-api-key",
scopes: ["mail.send", "alerts.read"],
});
const template = new sendgrid.Template("myTemplate", {
name: "welcome-email",
generation: "dynamic",
});
export const apiKeyId = apiKey.apiKeyId;
export const templateId = template.templateId;
See the examples/ directory for complete programs in Go, Python, .NET, and YAML.
Resources
| Resource | Description |
|---|---|
sendgrid:Alert |
Email alerts for usage and statistics thresholds |
sendgrid:ApiKey |
API keys with scoped permissions |
sendgrid:DomainAuthentication |
Domain authentication (DKIM/SPF) for sender identity |
sendgrid:EventWebhook |
Webhooks for email event notifications |
sendgrid:GlobalSuppression |
Global unsubscribe entries |
sendgrid:IpPool |
IP pools for organizing dedicated IPs (Pro plan) |
sendgrid:LinkBranding |
Branded tracking links for click/open tracking |
sendgrid:Subuser |
Subuser accounts with independent settings (Pro plan) |
sendgrid:Teammate |
Teammate accounts with role-based access |
sendgrid:Template |
Transactional email templates |
sendgrid:TemplateVersion |
Versioned content for email templates |
sendgrid:UnsubscribeGroup |
Suppression groups for subscription management |
sendgrid:VerifiedSender |
Verified sender identities |
Development
Prerequisites
Build and install
make build install
Run provider unit tests
make test_provider
Regenerate SDKs after provider changes
make codegen
License
Apache 2.0 — see LICENSE for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pulumi_sendgrid-0.1.0a2.tar.gz.
File metadata
- Download URL: pulumi_sendgrid-0.1.0a2.tar.gz
- Upload date:
- Size: 22.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f7793738925a88f60113ab351976e1236f7e846e499946a79f243d85bbbd12c1
|
|
| MD5 |
4a629710597b9127a6681ff69f9c1364
|
|
| BLAKE2b-256 |
8d23569dc1a88550cda486ac56ee0448616edf07e97bfc0ce0b29ddd4c77948c
|
Provenance
The following attestation bundles were made for pulumi_sendgrid-0.1.0a2.tar.gz:
Publisher:
release.yml on JDetmar/pulumi-sendgrid
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pulumi_sendgrid-0.1.0a2.tar.gz -
Subject digest:
f7793738925a88f60113ab351976e1236f7e846e499946a79f243d85bbbd12c1 - Sigstore transparency entry: 925525145
- Sigstore integration time:
-
Permalink:
JDetmar/pulumi-sendgrid@1a618c85e52799c40012da47f748cb8646e9a9f6 -
Branch / Tag:
refs/tags/v0.1.0-alpha.2 - Owner: https://github.com/JDetmar
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@1a618c85e52799c40012da47f748cb8646e9a9f6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file pulumi_sendgrid-0.1.0a2-py3-none-any.whl.
File metadata
- Download URL: pulumi_sendgrid-0.1.0a2-py3-none-any.whl
- Upload date:
- Size: 39.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4ad55ce8de2b473f7d96cc8406080691335ef3ec119b1e6798cacc5c56083b7b
|
|
| MD5 |
f1d02b598905e432ef38503177804734
|
|
| BLAKE2b-256 |
3b698bdf6413cf651bdbfc36a25cbb8a5c932ef1913207bd8ad269956b6d2bae
|
Provenance
The following attestation bundles were made for pulumi_sendgrid-0.1.0a2-py3-none-any.whl:
Publisher:
release.yml on JDetmar/pulumi-sendgrid
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pulumi_sendgrid-0.1.0a2-py3-none-any.whl -
Subject digest:
4ad55ce8de2b473f7d96cc8406080691335ef3ec119b1e6798cacc5c56083b7b - Sigstore transparency entry: 925525152
- Sigstore integration time:
-
Permalink:
JDetmar/pulumi-sendgrid@1a618c85e52799c40012da47f748cb8646e9a9f6 -
Branch / Tag:
refs/tags/v0.1.0-alpha.2 - Owner: https://github.com/JDetmar
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@1a618c85e52799c40012da47f748cb8646e9a9f6 -
Trigger Event:
push
-
Statement type: