software.amazon.awscdk.services.pinpoint

Class CfnEmailTemplate

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.215Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEmailTemplate(Construct scope, java.lang.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
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the message template.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDefaultSubstitutions() A JSON object that specifies the default values to use for message variables in the message template.
java.lang.String	getHtmlPart() The message body, in HTML format, to use in email messages that are based on the message template.
java.lang.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.
java.lang.String	getTemplateDescription() A custom description of the message template.
java.lang.String	getTemplateName() The name of the message template.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDefaultSubstitutions(java.lang.String value) A JSON object that specifies the default values to use for message variables in the message template.
void	setHtmlPart(java.lang.String value) The message body, in HTML format, to use in email messages that are based on the message template.
void	setSubject(java.lang.String value) The subject line, or title, to use in email messages that are based on the message template.
void	setTemplateDescription(java.lang.String value) A custom description of the message template.
void	setTemplateName(java.lang.String value) The name of the message template.
void	setTextPart(java.lang.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnEmailTemplate(Construct scope,
                        java.lang.String id,
                        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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

For more information, see Tag .

getSubject

public java.lang.String getSubject()

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

setSubject

public void setSubject(java.lang.String value)

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

getTemplateName

public java.lang.String getTemplateName()

The name of the message template.

setTemplateName

public void setTemplateName(java.lang.String value)

The name of the message template.

getDefaultSubstitutions

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

public void setDefaultSubstitutions(java.lang.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

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

public void setHtmlPart(java.lang.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

public java.lang.String getTemplateDescription()

A custom description of the message template.

setTemplateDescription

public void setTemplateDescription(java.lang.String value)

A custom description of the message template.

getTextPart

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

public void setTextPart(java.lang.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.