Package software.amazon.awscdk.services.pinpoint

Class CfnEmailTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.pinpoint.CfnEmailTemplate
All Implemented Interfaces:
IInspectable, ITaggable, IEmailTemplateRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:43.193Z") @Stability(Stable) public class CfnEmailTemplate extends CfnResource implements IInspectable, IEmailTemplateRef, ITaggable
Creates a message template that you can use in messages that are sent through the email channel.

A message template is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

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;
 CfnEmailTemplate cfnEmailTemplate = CfnEmailTemplate.Builder.create(this, "MyCfnEmailTemplate")
         .subject("subject")
         .templateName("templateName")
         // the properties below are optional
         .defaultSubstitutions("defaultSubstitutions")
         .htmlPart("htmlPart")
         .tags(tags)
         .templateDescription("templateDescription")
         .textPart("textPart")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEmailTemplate

      protected CfnEmailTemplate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEmailTemplate

      protected CfnEmailTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEmailTemplate

      @Stability(Stable) public CfnEmailTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEmailTemplateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the message template.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEmailTemplateRef

      @Stability(Stable) @NotNull public EmailTemplateReference getEmailTemplateRef()
      A reference to a EmailTemplate resource.
      Specified by:
      getEmailTemplateRef in interface IEmailTemplateRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getSubject

      @Stability(Stable) @NotNull public String getSubject()
      The subject line, or title, to use in email messages that are based on the message template.

    • setSubject

      @Stability(Stable) public void setSubject(@NotNull String value)
      The subject line, or title, to use in email messages that are based on the message template.

    • getTemplateName

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

    • setTemplateName

      @Stability(Stable) public void setTemplateName(@NotNull String value)
      The name of the message template.

    • getDefaultSubstitutions

      @Stability(Stable) @Nullable public String getDefaultSubstitutions()
      A JSON object that specifies the default values to use for message variables in the message template.

    • setDefaultSubstitutions

      @Stability(Stable) public void setDefaultSubstitutions(@Nullable String value)
      A JSON object that specifies the default values to use for message variables in the message template.

    • getHtmlPart

      @Stability(Stable) @Nullable public String getHtmlPart()
      The message body, in HTML format, to use in email messages that are based on the message template.

    • setHtmlPart

      @Stability(Stable) public void setHtmlPart(@Nullable String value)
      The message body, in HTML format, to use in email messages that are based on the message template.

    • getTagsRaw

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

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      An array of key-value pairs to apply to this resource.

    • getTemplateDescription

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

    • setTemplateDescription

      @Stability(Stable) public void setTemplateDescription(@Nullable String value)
      A custom description of the message template.

    • getTextPart

      @Stability(Stable) @Nullable public String getTextPart()
      The message body, in plain text format, to use in email messages that are based on the message template.

    • setTextPart

      @Stability(Stable) public void setTextPart(@Nullable String value)
      The message body, in plain text format, to use in email messages that are based on the message template.