Package software.amazon.awscdk.services.ses

Class CfnTemplate

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.ses.CfnTemplate

All Implemented Interfaces:

IInspectable, ITemplateRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:48.923Z")
@Stability(Stable)
public class CfnTemplate
extends CfnResource
implements IInspectable, ITemplateRef

Specifies an email template.

Email templates enable you to send personalized email to one or more destinations in a single API operation.

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.ses.*;
 CfnTemplate cfnTemplate = CfnTemplate.Builder.create(this, "MyCfnTemplate")
         .template(TemplateProperty.builder()
                 .subjectPart("subjectPart")
                 // the properties below are optional
                 .htmlPart("htmlPart")
                 .templateName("templateName")
                 .textPart("textPart")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-template.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTemplate.Builder	A fluent builder for CfnTemplate.
static interface	CfnTemplate.TemplateProperty	An object that defines the email template to use for an email message, and the values to use for any message variables in that template.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ses.ITemplateRef

ITemplateRef.Jsii$Default, ITemplateRef.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTemplate(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTemplate(software.constructs.Construct scope, String id)
	CfnTemplate(software.constructs.Construct scope, String id, CfnTemplateProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
Object	getTemplate()	The content of the email, composed of a subject line and either an HTML part or a text-only part.
TemplateReference	getTemplateRef()	A reference to a Template resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setTemplate(IResolvable value)	The content of the email, composed of a subject line and either an HTML part or a text-only part.
void	setTemplate(CfnTemplate.TemplateProperty value)	The content of the email, composed of a subject line and either an HTML part or a text-only part.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnTemplate

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

CfnTemplate

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

CfnTemplate

@Stability(Stable)
public CfnTemplate(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnTemplateProps 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.

CfnTemplate

@Stability(Stable)
public CfnTemplate(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

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.

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.

getAttrId

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTemplateRef

@Stability(Stable)
@NotNull
public TemplateReference getTemplateRef()

A reference to a Template resource.

Specified by:

getTemplateRef in interface ITemplateRef

getTemplate

@Stability(Stable)
@Nullable
public Object getTemplate()

The content of the email, composed of a subject line and either an HTML part or a text-only part.

Returns union: either IResolvable or CfnTemplate.TemplateProperty

setTemplate

@Stability(Stable)
public void setTemplate(@Nullable
 IResolvable value)

The content of the email, composed of a subject line and either an HTML part or a text-only part.

setTemplate

@Stability(Stable)
public void setTemplate(@Nullable
 CfnTemplate.TemplateProperty value)

The content of the email, composed of a subject line and either an HTML part or a text-only part.