Package software.amazon.awscdk.services.pinpoint

Class CfnEmailTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.pinpoint.CfnEmailTemplate
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.824Z") @Stability(Stable) public class CfnEmailTemplate extends CfnResource implements IInspectable
A CloudFormation AWS::Pinpoint::EmailTemplate.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnEmailTemplateProps props)
      Create a new AWS::Pinpoint::EmailTemplate.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

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

      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.

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

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

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

      We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

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

      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.

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

      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.