Package software.amazon.awscdk.services.pinpoint

Interface CfnEmailTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEmailTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:56:02.513Z")
@Stability(Stable)
public interface CfnEmailTemplateProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.pinpoint.*;
 Object tags;
 CfnEmailTemplateProps cfnEmailTemplateProps = CfnEmailTemplateProps.builder()
         .subject("subject")
         .templateName("templateName")
         // the properties below are optional
         .defaultSubstitutions("defaultSubstitutions")
         .htmlPart("htmlPart")
         .tags(tags)
         .templateDescription("templateDescription")
         .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	CfnEmailTemplateProps.Builder	A builder for CfnEmailTemplateProps
static final class	CfnEmailTemplateProps.Jsii$Proxy	An implementation for CfnEmailTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnEmailTemplateProps.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.
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.
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

getSubject

@Stability(Stable)
@NotNull
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

getTemplateName

@Stability(Stable)
@NotNull
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

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

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

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 CfnEmailTemplateProps.Builder builder()

Returns:

a CfnEmailTemplateProps.Builder of CfnEmailTemplateProps