Package software.amazon.awscdk.services.ses

Class CfnTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
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.ses.CfnTemplate
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.401Z") @Stability(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();

  • 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 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(Stable) public CfnTemplate(@NotNull 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 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

    • 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.

    • 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.