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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html

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.

string? DefaultSubstitutions { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-defaultsubstitutions

HtmlPart

The message body, in HTML format, to use in email messages that are based on the message template.

string? HtmlPart { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-htmlpart

Subject

The subject line, or title, to use in email messages that are based on the message template.

string Subject { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-subject

Tags

An array of key-value pairs to apply to this resource.

object? Tags { get; }

Property Value

object

Remarks

For more information, see Tag .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-tags

TemplateDescription

A custom description of the message template.

string? TemplateDescription { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-templatedescription

TemplateName

The name of the message template.

string TemplateName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-templatename

TextPart

The message body, in plain text format, to use in email messages that are based on the message template.

string? TextPart { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-textpart