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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.220Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEmailTemplate.Builder A fluent builder for CfnEmailTemplate.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEmailTemplate(software.constructs.Construct scope, String id, CfnEmailTemplateProps props) Create a new `AWS::Pinpoint::EmailTemplate`.
protected	CfnEmailTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEmailTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the message template.
protected Map<String,Object>	getCfnProperties()
String	getDefaultSubstitutions() A JSON object that specifies the default values to use for message variables in the message template.
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.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getTemplateDescription() A custom description of the message template.
String	getTemplateName() The name of the message template.
String	getTextPart() The message body, in plain text format, to use in email messages that are based on the message template.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDefaultSubstitutions(String value) A JSON object that specifies the default values to use for message variables in the message template.
void	setHtmlPart(String value) The message body, in HTML format, to use in email messages that are based on the message template.
void	setSubject(String value) The subject line, or title, to use in email messages that are based on the message template.
void	setTemplateDescription(String value) A custom description of the message template.
void	setTemplateName(String value) The name of the message template.
void	setTextPart(String value) The message body, in plain text format, to use in email messages that are based on the message template.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEmailTemplate

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

CfnEmailTemplate

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

CfnEmailTemplate

@Stability(value=Stable)
public CfnEmailTemplate(@NotNull
                                                 software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the message template.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getSubject

@Stability(value=Stable)
 @NotNull
public String getSubject()

The subject line, or title, to use in email messages that are based on the message template.

setSubject

@Stability(value=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(value=Stable)
 @NotNull
public String getTemplateName()

The name of the message template.

setTemplateName

@Stability(value=Stable)
public void setTemplateName(@NotNull
                                                     String value)

The name of the message template.

getDefaultSubstitutions

@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getTemplateDescription()

A custom description of the message template.

setTemplateDescription

@Stability(value=Stable)
public void setTemplateDescription(@Nullable
                                                            String value)

A custom description of the message template.

getTextPart

@Stability(value=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(value=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.