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.104.0 (build e79254c)",
date="2024-11-06T23:25:17.205Z")
@Stability(Stable)
public class CfnTemplate
extends CfnResource
implements IInspectable
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnTemplate
.static interface
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
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe 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.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
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.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTemplate
The content of the email, composed of a subject line and either an HTML part or a text-only part. -
setTemplate
The content of the email, composed of a subject line and either an HTML part or a text-only part. -
setTemplate
The content of the email, composed of a subject line and either an HTML part or a text-only part.
-