Package software.amazon.awscdk.cfnpropertymixins.services.pinpoint

Interface CfnEmailTemplateMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEmailTemplateMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:02.296Z")
@Stability(Stable)
public interface CfnEmailTemplateMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnEmailTemplatePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.pinpoint.*;
 Object tags;
 CfnEmailTemplateMixinProps cfnEmailTemplateMixinProps = CfnEmailTemplateMixinProps.builder()
         .defaultSubstitutions("defaultSubstitutions")
         .htmlPart("htmlPart")
         .subject("subject")
         .tags(tags)
         .templateDescription("templateDescription")
         .templateName("templateName")
         .textPart("textPart")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEmailTemplateMixinProps.Builder	A builder for CfnEmailTemplateMixinProps
static final class	CfnEmailTemplateMixinProps.Jsii$Proxy	An implementation for CfnEmailTemplateMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnEmailTemplateMixinProps.Builder	builder()
default String	getDefaultSubstitutions()	A JSON object that specifies the default values to use for message variables in the message template.
default String	getHtmlPart()	The message body, in HTML format, to use in email messages that are based on the message template.
default String	getSubject()	The subject line, or title, to use in email messages that are based on the message template.
default Object	getTags()	An array of key-value pairs to apply to this resource.
default String	getTemplateDescription()	A custom description of the message template.
default String	getTemplateName()	The name of the message template.
default String	getTextPart()	The message body, in plain text format, to use in email messages that are based on the message template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultSubstitutions

@Stability(Stable)
@Nullable
default String getDefaultSubstitutions()

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.

See Also:

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

getHtmlPart

@Stability(Stable)
@Nullable
default String getHtmlPart()

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.

See Also:

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

getSubject

@Stability(Stable)
@Nullable
default String getSubject()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Object getTags()

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

For more information, see Tag .

See Also:

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

getTemplateDescription

@Stability(Stable)
@Nullable
default String getTemplateDescription()

A custom description of the message template.

See Also:

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

getTemplateName

@Stability(Stable)
@Nullable
default String getTemplateName()

The name of the message template.

See Also:

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

getTextPart

@Stability(Stable)
@Nullable
default String getTextPart()

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.

See Also:

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

builder

@Stability(Stable)
static CfnEmailTemplateMixinProps.Builder builder()

Returns:

a CfnEmailTemplateMixinProps.Builder of CfnEmailTemplateMixinProps