AWS::Pinpoint::EmailTemplateCfnEmailTemplate
Creates a message template that you can use in messages that are sent through the email channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.
Import
import { CfnEmailTemplate } from 'aws-cdk-lib/aws-pinpoint';Or use the module namespace:
import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnEmailTemplateProperties
Configuration passed to the constructor as CfnEmailTemplateProps.
subjectRequiredstringThe subject line, or title, to use in email messages that are based on the message template.
templateNameRequiredstringThe name of the message template.
defaultSubstitutionsOptionalstringA JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
htmlPartOptionalstringThe message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
tagsOptionalanyAn array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
templateDescriptionOptionalstringA custom description of the message template.
textPartOptionalstringThe message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-pinpointAWS::Pinpoint::EmailTemplate