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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.195Z")
 @Stability(value=Stable)
public class CfnTemplate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SES::Template`.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTemplate.Builder A fluent builder for CfnTemplate.
static interface	CfnTemplate.TemplateProperty The content of the email, composed of a subject line and either an HTML part or a text-only part.

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
	CfnTemplate(software.constructs.Construct scope, String id) Create a new `AWS::SES::Template`.
	CfnTemplate(software.constructs.Construct scope, String id, CfnTemplateProps props) Create a new `AWS::SES::Template`.
protected	CfnTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and 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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
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.
void	setTemplate(IResolvable 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, 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

CfnTemplate

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

CfnTemplate

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

CfnTemplate

@Stability(value=Stable)
public CfnTemplate(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @Nullable
                                            CfnTemplateProps props)

Create a new `AWS::SES::Template`.

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.

CfnTemplate

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

Create a new `AWS::SES::Template`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. 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.

getAttrId

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTemplate

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

setTemplate

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

setTemplate

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