Class CfnEmailTemplateProps.Builder
java.lang.Object
software.amazon.awscdk.services.pinpoint.CfnEmailTemplateProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEmailTemplateProps>
- Enclosing interface:
- CfnEmailTemplateProps
@Stability(Stable)
public static final class CfnEmailTemplateProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEmailTemplateProps>
A builder for
CfnEmailTemplateProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.defaultSubstitutions
(String defaultSubstitutions) Sets the value ofCfnEmailTemplateProps.getDefaultSubstitutions()
Sets the value ofCfnEmailTemplateProps.getHtmlPart()
Sets the value ofCfnEmailTemplateProps.getSubject()
Sets the value ofCfnEmailTemplateProps.getTags()
templateDescription
(String templateDescription) Sets the value ofCfnEmailTemplateProps.getTemplateDescription()
templateName
(String templateName) Sets the value ofCfnEmailTemplateProps.getTemplateName()
Sets the value ofCfnEmailTemplateProps.getTextPart()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
subject
Sets the value ofCfnEmailTemplateProps.getSubject()
- Parameters:
subject
- The subject line, or title, to use in email messages that are based on the message template. This parameter is required.- Returns:
this
-
templateName
Sets the value ofCfnEmailTemplateProps.getTemplateName()
- Parameters:
templateName
- The name of the message template. This parameter is required.- Returns:
this
-
defaultSubstitutions
@Stability(Stable) public CfnEmailTemplateProps.Builder defaultSubstitutions(String defaultSubstitutions) Sets the value ofCfnEmailTemplateProps.getDefaultSubstitutions()
- Parameters:
defaultSubstitutions
- 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.- Returns:
this
-
htmlPart
Sets the value ofCfnEmailTemplateProps.getHtmlPart()
- Parameters:
htmlPart
- 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.- Returns:
this
-
tags
Sets the value ofCfnEmailTemplateProps.getTags()
- Parameters:
tags
- An array of key-value pairs to apply to this resource. For more information, see Tag .- Returns:
this
-
templateDescription
@Stability(Stable) public CfnEmailTemplateProps.Builder templateDescription(String templateDescription) Sets the value ofCfnEmailTemplateProps.getTemplateDescription()
- Parameters:
templateDescription
- A custom description of the message template.- Returns:
this
-
textPart
Sets the value ofCfnEmailTemplateProps.getTextPart()
- Parameters:
textPart
- 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.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnEmailTemplateProps>
- Returns:
- a new instance of
CfnEmailTemplateProps
- Throws:
NullPointerException
- if any required attribute was not provided
-