Class CfnEmailTemplate

Creates a message template that you can use in messages that are sent through the email channel.

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnEmailTemplate

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(Object)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<ResolutionTypeHint>)

CfnResource.GetMetadata(String)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEmailTemplate : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnEmailTemplate
    Inherits CfnResource
    Implements IInspectable, ITaggable

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html

CloudformationResource: AWS::Pinpoint::EmailTemplate

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;

var tags;

var cfnEmailTemplate = new CfnEmailTemplate(this, "MyCfnEmailTemplate", new CfnEmailTemplateProps {
    Subject = "subject",
    TemplateName = "templateName",

    // the properties below are optional
    DefaultSubstitutions = "defaultSubstitutions",
    HtmlPart = "htmlPart",
    Tags = tags,
    TemplateDescription = "templateDescription",
    TextPart = "textPart"
});

Synopsis

Constructors

CfnEmailTemplate(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnEmailTemplate(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
CfnEmailTemplate(Construct, String, ICfnEmailTemplateProps)

Properties

AttrArn	The Amazon Resource Name (ARN) of the message template.
AttrId
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
DefaultSubstitutions	A JSON object that specifies the default values to use for message variables in the message template.
HtmlPart	The message body, in HTML format, to use in email messages that are based on the message template.
Subject	The subject line, or title, to use in email messages that are based on the message template.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	An array of key-value pairs to apply to this resource.
TemplateDescription	A custom description of the message template.
TemplateName	The name of the message template.
TextPart	The message body, in plain text format, to use in email messages that are based on the message template.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnEmailTemplate(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnEmailTemplate(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnEmailTemplate(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnEmailTemplate(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

CfnEmailTemplate(Construct, String, ICfnEmailTemplateProps)

public CfnEmailTemplate(Construct scope, string id, ICfnEmailTemplateProps props)

Parameters

scope Constructs.Construct: Scope in which this resource is defined.
id System.String: Construct identifier for this resource (unique in its scope).
props ICfnEmailTemplateProps: Resource properties.

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrId

public virtual string AttrId { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

DefaultSubstitutions

A JSON object that specifies the default values to use for message variables in the message template.

public virtual string DefaultSubstitutions { get; set; }

Property Value

System.String

HtmlPart

The message body, in HTML format, to use in email messages that are based on the message template.

public virtual string HtmlPart { get; set; }

Property Value

System.String

Subject

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

public virtual string Subject { get; set; }

Property Value

System.String

TagsRaw

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

public virtual object TagsRaw { get; set; }

Property Value

System.Object

TemplateDescription

A custom description of the message template.

public virtual string TemplateDescription { get; set; }

Property Value

System.String

TemplateName

The name of the message template.

public virtual string TemplateName { get; set; }

Property Value

System.String

TextPart

The message body, in plain text format, to use in email messages that are based on the message template.

public virtual string TextPart { get; set; }

Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable

ITaggable