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.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.826Z") @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();

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

    • getTemplateName

      @Stability(Stable) @NotNull String getTemplateName()
      The name of the message template.

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

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

    • getTags

      @Stability(Stable) @Nullable default Object getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getTemplateDescription

      @Stability(Stable) @Nullable default String getTemplateDescription()
      A custom description of the message template.

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

    • builder

      @Stability(Stable) static CfnEmailTemplateProps.Builder builder()
      Returns:
      a CfnEmailTemplateProps.Builder of CfnEmailTemplateProps