Skip to main content

A Pulumi provider for managing SendGrid resources.

Project description

Pulumi SendGrid Provider

Build Status License: Apache 2.0 npm version PyPI version NuGet version Go Reference Go Report Card

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulumi_sendgrid-0.1.0a2.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pulumi_sendgrid-0.1.0a2-py3-none-any.whl (39.4 kB view details)

Uploaded Python 3

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

Hashes for pulumi_sendgrid-0.1.0a2.tar.gz
Algorithm Hash digest
SHA256 f7793738925a88f60113ab351976e1236f7e846e499946a79f243d85bbbd12c1
MD5 4a629710597b9127a6681ff69f9c1364
BLAKE2b-256 8d23569dc1a88550cda486ac56ee0448616edf07e97bfc0ce0b29ddd4c77948c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pulumi_sendgrid-0.1.0a2.tar.gz:

Publisher: release.yml on JDetmar/pulumi-sendgrid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pulumi_sendgrid-0.1.0a2-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_sendgrid-0.1.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 4ad55ce8de2b473f7d96cc8406080691335ef3ec119b1e6798cacc5c56083b7b
MD5 f1d02b598905e432ef38503177804734
BLAKE2b-256 3b698bdf6413cf651bdbfc36a25cbb8a5c932ef1913207bd8ad269956b6d2bae

See more details on using hashes here.

Provenance

The following attestation bundles were made for pulumi_sendgrid-0.1.0a2-py3-none-any.whl:

Publisher: release.yml on JDetmar/pulumi-sendgrid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page