EmailTemplate class

> NOTE: This resource is deprecated. AWS End User Messaging email features are being discontinued on October 30, 2026. Migrate to Amazon SES using aws.ses.Template or aws.sesv2.EmailIdentity and related SESv2 resources. See the AWS End User Messaging migration guide for details.

Provides an End User Messaging Email Template resource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.pinpoint.EmailTemplate("test", {
    emailTemplates: [{
        headers: [{
            name: "testingname",
            value: "testingvalue",
        }],
        subject: "testing",
        textPart: "we are testing template text part",
    }],
    templateName: "testing",
});
import pulumi
import pulumi_aws as aws

test = aws.pinpoint.EmailTemplate("test",
    email_templates=[{
        "headers": [{
            "name": "testingname",
            "value": "testingvalue",
        }],
        "subject": "testing",
        "text_part": "we are testing template text part",
    }],
    template_name="testing")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.Pinpoint.EmailTemplate("test", new()
    {
        EmailTemplates = new[]
        {
            new Aws.Pinpoint.Inputs.EmailTemplateEmailTemplateArgs
            {
                Headers = new[]
                {
                    new Aws.Pinpoint.Inputs.EmailTemplateEmailTemplateHeaderArgs
                    {
                        Name = "testingname",
                        Value = "testingvalue",
                    },
                },
                Subject = "testing",
                TextPart = "we are testing template text part",
            },
        },
        TemplateName = "testing",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := pinpoint.NewEmailTemplate(ctx, "test", &pinpoint.EmailTemplateArgs{
			EmailTemplates: pinpoint.EmailTemplateEmailTemplateArray{
				&pinpoint.EmailTemplateEmailTemplateArgs{
					Headers: pinpoint.EmailTemplateEmailTemplateHeaderArray{
						&pinpoint.EmailTemplateEmailTemplateHeaderArgs{
							Name:  pulumi.String("testingname"),
							Value: pulumi.String("testingvalue"),
						},
					},
					Subject:  pulumi.String("testing"),
					TextPart: pulumi.String("we are testing template text part"),
				},
			},
			TemplateName: pulumi.String("testing"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_pinpoint_emailtemplate" "test" {
  email_templates {
    headers {
      name  = "testingname"
      value = "testingvalue"
    }
    subject   = "testing"
    text_part = "we are testing template text part"
  }
  template_name = "testing"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.EmailTemplate;
import com.pulumi.aws.pinpoint.EmailTemplateArgs;
import com.pulumi.aws.pinpoint.inputs.EmailTemplateEmailTemplateArgs;
import com.pulumi.aws.pinpoint.inputs.EmailTemplateEmailTemplateHeaderArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new EmailTemplate("test", EmailTemplateArgs.builder()
            .emailTemplates(EmailTemplateEmailTemplateArgs.builder()
                .headers(EmailTemplateEmailTemplateHeaderArgs.builder()
                    .name("testingname")
                    .value("testingvalue")
                    .build())
                .subject("testing")
                .textPart("we are testing template text part")
                .build())
            .templateName("testing")
            .build());

    }
}
resources:
  test:
    type: aws:pinpoint:EmailTemplate
    properties:
      emailTemplates:
        - headers:
            - name: testingname
              value: testingvalue
          subject: testing
          textPart: we are testing template text part
      templateName: testing

Import

Using pulumi import, import End User Messaging Email Template using the templateName. For example:

$ pulumi import aws:pinpoint/emailTemplate:EmailTemplate reset template_name

Constructors

EmailTemplate(String name, {EmailTemplateArgs? args, CustomResourceOptions? options})
Creates a new EmailTemplate. name The Pulumi resource name. args Arguments used to configure this EmailTemplate. The set of arguments for EmailTemplate. options Resource options controlling this resource's behavior.
EmailTemplate.reference(String urn)
Creates a typed reference to an existing EmailTemplate resource.

Properties

arn ↔ Output<String>
ARN of the message template.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
emailTemplates ↔ Output<List<EmailTemplateEmailTemplate>?>
Content and settings for a message template that can be used in messages that are sent through the email channel. See below.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
templateName ↔ Output<String>
Name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {EmailTemplateState? state, CustomResourceOptions? options}) → EmailTemplate
Gets an existing EmailTemplate resource's state with the given name and id.