Interface ICfnEmailTemplateProps
Properties for defining a CfnEmailTemplate
.
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnEmailTemplateProps
Syntax (vb)
Public Interface ICfnEmailTemplateProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;
var tags;
var cfnEmailTemplateProps = new CfnEmailTemplateProps {
Subject = "subject",
TemplateName = "templateName",
// the properties below are optional
DefaultSubstitutions = "defaultSubstitutions",
HtmlPart = "htmlPart",
Tags = tags,
TemplateDescription = "templateDescription",
TextPart = "textPart"
};
Synopsis
Properties
DefaultSubstitutions | A JSON object that specifies the default values to use for message variables in the message template. |
HtmlPart | The message body, in HTML format, to use in email messages that are based on the message template. |
Subject | The subject line, or title, to use in email messages that are based on the message template. |
Tags | An array of key-value pairs to apply to this resource. |
TemplateDescription | A custom description of the message template. |
TemplateName | The name of the message template. |
TextPart | The message body, in plain text format, to use in email messages that are based on the message template. |
Properties
DefaultSubstitutions
A JSON object that specifies the default values to use for message variables in the message template.
virtual string DefaultSubstitutions { get; }
Property Value
System.String
Remarks
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.
HtmlPart
The message body, in HTML format, to use in email messages that are based on the message template.
virtual string HtmlPart { get; }
Property Value
System.String
Remarks
We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
Subject
The subject line, or title, to use in email messages that are based on the message template.
string Subject { get; }
Property Value
System.String
Remarks
Tags
An array of key-value pairs to apply to this resource.
virtual object Tags { get; }
Property Value
System.Object
Remarks
TemplateDescription
A custom description of the message template.
virtual string TemplateDescription { get; }
Property Value
System.String
Remarks
TemplateName
The name of the message template.
string TemplateName { get; }
Property Value
System.String
Remarks
TextPart
The message body, in plain text format, to use in email messages that are based on the message template.
virtual string TextPart { get; }
Property Value
System.String
Remarks
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.