CfnEmailTemplateProps

class aws_cdk.aws_pinpoint.CfnEmailTemplateProps(*, subject, template_name, default_substitutions=None, html_part=None, tags=None, template_description=None, text_part=None)

Bases: object

Properties for defining a CfnEmailTemplate.

Parameters:

  • subject (str) – The subject line, or title, to use in email messages that are based on the message template.

  • template_name (str) – The name of the message template.

  • default_substitutions (Optional[str]) – A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that’s based on the template, you can override these defaults with message-specific and address-specific variables and values.

  • html_part (Optional[str]) – The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

  • tags (Optional[Any]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • template_description (Optional[str]) – A custom description of the message template.

  • text_part (Optional[str]) – The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don’t render HTML content and clients that are connected to high-latency networks, such as mobile devices.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

# tags: Any

cfn_email_template_props = pinpoint.CfnEmailTemplateProps(
    subject="subject",
    template_name="templateName",

    # the properties below are optional
    default_substitutions="defaultSubstitutions",
    html_part="htmlPart",
    tags=tags,
    template_description="templateDescription",
    text_part="textPart"
)

Attributes

default_substitutions

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

This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that’s based on the template, you can override these defaults with message-specific and address-specific variables and values.

Link:

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

html_part

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

We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

Link:

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

subject

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

Link:

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

tags

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

For more information, see Tag .

Link:

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

template_description

A custom description of the message template.

Link:

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

template_name

The name of the message template.

Link:

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

text_part

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

We recommend using plain text format for email clients that don’t render HTML content and clients that are connected to high-latency networks, such as mobile devices.

Link:

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