sendgrid

Documentation

Overview

Resources List

API key Resource

sendgrid_api_key

Domain authentication Resource

sendgrid_domain_authentication

Link branding Resource

sendgrid_link_branding

SSO Resources

sendgrid_sso_certificate
sendgrid sso_integration

Subuser Resource

sendgrid_subuser

Template Resources

sendgrid_template
sendgrid_template_version

Unsubscribe Group Resource

sendgrid_unsubscribe_group

WebHook Resources

sendgrid_parse_webhook
sendgrid_event_webhook

Provide a resource to manage an API key. Example Usage ```hcl

resource "sendgrid_api_key" "api_key" {
	name   = "my-api-key"
	scopes = [
		"mail.send",
		"sender_verification_eligible",
	]
}

``` Import An API key can be imported, e.g. ```hcl $ terraform import sendgrid_api_key.api_key apiKeyID ```

Provide a resource to manage a domain authentication. Example Usage ```hcl

resource "sendgrid_domain_authentication" "default" {
	domain = "example.com"
    ips = [ "10.10.10.10" ]
    is_default = true
    automatic_security = false
}

``` Import An unsubscribe group can be imported, e.g. ```hcl $ terraform import sendgrid_domain_authentication.default domainId ```

Provide a resource to manage an event webhook settings. Example Usage ```hcl

resource "sendgrid_event_webhook" "default" {
	enabled = true
    url = "https://foo.bar/sendgrid/inbound"
    group_resubscribe = true
    delivered = true
    group_unsubscribe = true
    spam_report = true
    bounce = true
    deferred = true
    unsubscribe = true
    processed = true
    open = true
    click = true
    dropped = true
    oauth_client_id = "a-client-id"
    oauth_client_secret = "a-client-secret"
    oauth_token_url = "https://oauth.example.com/token"
}

```

Provide a resource to manage link branding. Example Usage ```hcl

resource "sendgrid_link_branding" "default" {
	domain = "example.com"
    is_default = true
}

``` Import An unsubscribe group can be imported, e.g. ```hcl $ terraform import sendgrid_link_branding.default linkId ```

Provide a resource to manage parse webhook settings. Example Usage ```hcl

resource "sendgrid_parse_webhook" "default" {
	hostname = "parse.foo.bar"
    url = "https://foo.bar/sendgrid/inbound"
    spam_check = false
    send_raw = false
}

``` Import An unsubscribe webhook can be imported, e.g. ```hcl $ terraform import sendgrid_parse_webhook.default hostname ```

Provide a resource to manage SSO certificates. Example Usage ```hcl

resource "sendgrid_sso_integration" "sso" {
	name    = "IdP"
	enabled = true

	signin_url  = "https://idp.com/signin"
	signout_url = "https://idp.com/signout"
	entity_id   = "https://idp.com/12345"
}

resource "sendgrid_sso_certificate" "cert" {
	integration_id = sendgrid_sso_integration.sso.id
	public_certificate = <<EOF

-----BEGIN CERTIFICATE----- ... EOF } ``` Import An SSO certificate can be imported, e.g. ```sh $ terraform import sendgrid_sso_certificate.cert <certificate-id> ```

Provide a resource to manage SSO integrations.

**Note** To finalize the integration, a user must click through the 'enable integration' workflow once after supplying all required fields including an SSO certificate via `aws_sso_certificate`. Example Usage ```hcl

resource "sendgrid_sso_integration" "sso" {
	name    = "IdP"
	enabled = false

	signin_url  = "https://idp.com/signin"
	signout_url = "https://idp.com/signout"
	entity_id   = "https://idp.com/12345"
}

``` Import A SSO integration can be imported, e.g. ```sh $ terraform import sendgrid_sso_integration.sso <integration-id> ```

Provide a resource to manage a subuser. Example Usage ```hcl

resource "sendgrid_subuser" "subuser" {
	username = "my-subuser"
	email    = "subuser@example.org"
	password = "Passw0rd!"
	ips      = [
		"127.0.0.1"
	]
}

``` Import A subuser can be imported, e.g. ```hcl $ terraform import sendgrid_subuser.subuser userName ```

Provide a resource to manage a subuser. Example Usage ```hcl

resource "sendgrid_teammate" "user" {
	email    = arslanbekov@gmail.com
	is_admin = false
	scopes   = [
		""
	]
}

```

Provide a resource to manage a template of email. Example Usage ```hcl

resource "sendgrid_template" "template" {
	name       = "my-template"
	generation = "dynamic"
}

``` Import A template can be imported, e.g. ```hcl $ terraform import sendgrid_template.template templateID ```

Provide a resource to manage a version of template. Example Usage ```hcl

resource "sendgrid_template" "template" {
	name       = "my-template"
	generation = "dynamic"
}

resource "sendgrid_template_version" "template_version" {
	name                   = "my-template-version"
	template_id            = sendgrid_template.template.id
	active                 = 1
	html_content           = "<%body%>"
	generate_plain_content = true
	subject                = "subject"
}

``` Import A template version can be imported, e.g. ```hcl $ terraform import sendgrid_template_version.template_version templateID/templateVersionId ```

Provide a resource to manage an unsubscribe group. Example Usage ```hcl

resource "sendgrid_unsubscribe_group" "default" {
	name   = "default-unsubscribe-group"
	description = "The default unsubscribe group"
    is_default = true
}

``` Import An unsubscribe group can be imported, e.g. ```hcl $ terraform import sendgrid_unsubscribe_group.default unsubscribeGroupID ```

Index

• Constants
• Variables
• func Provider() *schema.Provider

Constants

const ImportSplitParts = 2

ImportSplitParts is the expected length of the splitted import string for template versions.

Variables

var (
	// ErrCreateRateLimit error displayed when we reach the API calls rate limit.
	ErrCreateRateLimit = errors.New("expected instance to be created but we were rate limited")

	// ErrInvalidImportFormat error displayed when the string passed to import a template version
	// doesn't have the good format.
	ErrInvalidImportFormat = errors.New("invalid import. Supported import format: {{templateID}}/{{templateVersionID}}")

	// ErrSubUserNotFound error displayed when the subUser can not be found.
	ErrSubUserNotFound = errors.New("subUser wasn't found")

	// ErrNoNewVersionFoundForTemplate error displayed when no recent version can be found for a given template.
	ErrNoNewVersionFoundForTemplate = errors.New("no recent version found for template_id")

	// ErrSetTemplateName error displayed when the provider can't set the template name.
	ErrSetTemplateName = errors.New("could not set template name")

	// ErrSetTemplateGeneration error displayed when the provider can't set the template generation.
	ErrSetTemplateGeneration = errors.New("could not set template generation")

	// ErrSetTemplateUpdatedAt error displayed when the provider can't set the template updated_at attribute.
	ErrSetTemplateUpdatedAt = errors.New("could not set template version updated_at attribute")

	// ErrSetTemplateVersionName error displayed when the provider can't set the template version name.
	ErrSetTemplateVersionName = errors.New("could not set template version name")

	// ErrSetTemplateVersionUpdatedAt error displayed when the provider
	// can't set the template version updated_at attribute.
	ErrSetTemplateVersionUpdatedAt = errors.New("could not set template version updated_at attribute")

	// ErrSetTemplateVersionActive error displayed when the provider
	// can't set the template version active attribute.
	ErrSetTemplateVersionActive = errors.New("could not set template version active attribute")

	// ErrSetTemplateVersionHTMLContent error displayed when the provider
	// can't set the template version hmtl_content attribute.
	ErrSetTemplateVersionHTMLContent = errors.New("could not set template version html_content attribute")

	// ErrSetTemplateVersionPlainContent error displayed when the provider
	// can't set the template version plain_content attribute.
	ErrSetTemplateVersionPlainContent = errors.New("could not set template version plain_content attribute")

	// ErrSetTemplateVersionGenPlainContent error displayed when the provider
	// can't set the template version generate_plain_content attribute.
	ErrSetTemplateVersionGenPlainContent = errors.New("could not set template version generate_plain_content attribute")

	// ErrSetTemplateVersionSubject error displayed when the provider
	// can't set the template version subject attribute.
	ErrSetTemplateVersionSubject = errors.New("could not set template version subject attribute")

	// ErrSetTemplateVersionEditor error displayed when the provider
	// can't set the template version editor attribute.
	ErrSetTemplateVersionEditor = errors.New("could not set template version editor attribute")

	// ErrSetTemplateVersionThumbnailURL error displayed when the provider can't set the template version thumbnail URL.
	ErrSetTemplateVersionThumbnailURL = errors.New("could not set template version thumbnail URL")

	// ErrSetUnsubscribeGroupName error displayed when the provider can't set the unsubscribe group name.
	ErrSetUnsubscribeGroupName = errors.New("could not set unsubscribe group name")

	// ErrSetUnsubscribeGroupDesc error displayed when the provider can't set the unsubscribe group description.
	ErrSetUnsubscribeGroupDesc = errors.New("could not set unsubscribe group description")

	// ErrSetUnsubscribeGroupIsDefault error displayed when the provider can't set the unsubscribe group is_default flag.
	ErrSetUnsubscribeGroupIsDefault = errors.New("could not set unsubscribe group is_default flag")

	// ErrSetUnsubscribeGroupUnsuscribes error displayed when the provider
	// can't set the unsubscribe group unsubscribes attribute.
	ErrSetUnsubscribeGroupUnsuscribes = errors.New("could not set unsubscribe group unsubscribes attribute")
)

Functions

func Provider

func Provider() *schema.Provider

Provider terraform.ResourceProvider.