aws-cdk-lib.aws_pinpoint.CfnEmailTemplateProps

interface CfnEmailTemplateProps

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnEmailTemplateProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnEmailTemplateProps
Javasoftware.amazon.awscdk.services.pinpoint.CfnEmailTemplateProps
Pythonaws_cdk.aws_pinpoint.CfnEmailTemplateProps
TypeScript aws-cdk-lib » aws_pinpoint » CfnEmailTemplateProps

Properties for defining a CfnEmailTemplate.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pinpoint as pinpoint } from 'aws-cdk-lib';

declare const tags: any;
const cfnEmailTemplateProps: pinpoint.CfnEmailTemplateProps = {
  subject: 'subject',
  templateName: 'templateName',

  // the properties below are optional
  defaultSubstitutions: 'defaultSubstitutions',
  htmlPart: 'htmlPart',
  tags: tags,
  templateDescription: 'templateDescription',
  textPart: 'textPart',
};

Properties

NameTypeDescription
subjectstringThe subject line, or title, to use in email messages that are based on the message template.
templateNamestringThe name of the message template.
defaultSubstitutions?stringA JSON object that specifies the default values to use for message variables in the message template.
htmlPart?stringThe message body, in HTML format, to use in email messages that are based on the message template.
tags?anyAn array of key-value pairs to apply to this resource.
templateDescription?stringA custom description of the message template.
textPart?stringThe message body, in plain text format, to use in email messages that are based on the message template.

subject

Type: string

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


templateName

Type: string

The name of the message template.


defaultSubstitutions?

Type: string (optional)

A 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.


htmlPart?

Type: string (optional)

The 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.


tags?

Type: any (optional)

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

For more information, see Tag .


templateDescription?

Type: string (optional)

A custom description of the message template.


textPart?

Type: string (optional)

The 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.