Template class
Provides a resource to create a SES template.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const myTemplate = new aws.ses.Template("MyTemplate", {
name: "MyTemplate",
subject: "Greetings, {{name}}!",
html: "<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>",
text: `Hello {{name}},\x0d
Your favorite animal is {{favoriteanimal}}.`,
});
import pulumi
import pulumi_aws as aws
my_template = aws.ses.Template("MyTemplate",
name="MyTemplate",
subject="Greetings, {{name}}!",
html="<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>",
text="""Hello {{name}},\x0d
Your favorite animal is {{favoriteanimal}}.""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var myTemplate = new Aws.Ses.Template("MyTemplate", new()
{
Name = "MyTemplate",
Subject = "Greetings, {{name}}!",
Html = "<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>",
Text = @"Hello {{name}},
Your favorite animal is {{favoriteanimal}}.",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ses"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ses.NewTemplate(ctx, "MyTemplate", &ses.TemplateArgs{
Name: pulumi.String("MyTemplate"),
Subject: pulumi.String("Greetings, {{name}}!"),
Html: pulumi.String("<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>"),
Text: pulumi.String("Hello {{name}},\r\nYour favorite animal is {{favoriteanimal}}."),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ses_template" "MyTemplate" {
name = "MyTemplate"
subject = "Greetings, {{name}}!"
html = "<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>"
text = "Hello {{name}},\r\nYour favorite animal is {{favoriteanimal}}."
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ses.Template;
import com.pulumi.aws.ses.TemplateArgs;
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 myTemplate = new Template("myTemplate", TemplateArgs.builder()
.name("MyTemplate")
.subject("Greetings, {{name}}!")
.html("<h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>")
.text("""
Hello {{name}},
Your favorite animal is {{favoriteanimal}}. """)
.build());
}
}
resources:
myTemplate:
type: aws:ses:Template
name: MyTemplate
properties:
name: MyTemplate
subject: Greetings, {{name}}!
html: <h1>Hello {{name}},</h1><p>Your favorite animal is {{favoriteanimal}}.</p>
text: "Hello {{name}},\r\nYour favorite animal is {{favoriteanimal}}."
Import
Using pulumi import, import SES templates using the template name. For example:
$ pulumi import aws:ses/template:Template MyTemplate MyTemplate
Constructors
- Template(String name, {TemplateArgs? args, CustomResourceOptions? options})
-
Creates a new Template.
nameThe Pulumi resource name.argsArguments used to configure this Template. The set of arguments for Template.optionsResource options controlling this resource's behavior. - Template.reference(String urn)
- Creates a typed reference to an existing Template resource.
Properties
-
arn
↔ Output<
String> -
ARN of the SES template
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
html
↔ Output<
String?> -
HTML body of the email. Must be less than 500KB in size, including both the text and HTML parts.
latefinal
-
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
-
name
↔ Output<
String> -
Name of the template. Cannot exceed 64 characters. You will refer to this name when you send email.
latefinal
-
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
-
subject
↔ Output<
String?> -
Subject line of the email.
latefinal
-
text
↔ Output<
String?> -
Email body that will be visible to recipients whose email clients do not display HTML. Must be less than 500KB in size, including both the text and HTML parts.
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