Package software.amazon.awscdk.services.pinpoint

Class CfnEmailTemplate.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnEmailTemplate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEmailTemplate>

Enclosing class:

CfnEmailTemplate

@Stability(Stable)
public static final class CfnEmailTemplate.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEmailTemplate>

A fluent builder for CfnEmailTemplate.

Method Summary

Modifier and Type	Method	Description
CfnEmailTemplate	build()
static CfnEmailTemplate.Builder	create(software.constructs.Construct scope, String id)
CfnEmailTemplate.Builder	defaultSubstitutions(String defaultSubstitutions)	A JSON object that specifies the default values to use for message variables in the message template.
CfnEmailTemplate.Builder	htmlPart(String htmlPart)	The message body, in HTML format, to use in email messages that are based on the message template.
CfnEmailTemplate.Builder	subject(String subject)	The subject line, or title, to use in email messages that are based on the message template.
CfnEmailTemplate.Builder	tags(Object tags)	An array of key-value pairs to apply to this resource.
CfnEmailTemplate.Builder	templateDescription(String templateDescription)	A custom description of the message template.
CfnEmailTemplate.Builder	templateName(String templateName)	The name of the message template.
CfnEmailTemplate.Builder	textPart(String textPart)	The message body, in plain text format, to use in email messages that are based on the message template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnEmailTemplate.Builder create(software.constructs.Construct scope,
 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.

Returns:

a new instance of CfnEmailTemplate.Builder.

subject

@Stability(Stable)
public CfnEmailTemplate.Builder subject(String subject)

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

Parameters:

subject - The subject line, or title, to use in email messages that are based on the message template. This parameter is required.

Returns:

this

See Also:

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

templateName

@Stability(Stable)
public CfnEmailTemplate.Builder templateName(String templateName)

The name of the message template.

Parameters:

templateName - The name of the message template. This parameter is required.

Returns:

this

See Also:

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

defaultSubstitutions

@Stability(Stable)
public CfnEmailTemplate.Builder defaultSubstitutions(String defaultSubstitutions)

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.

Parameters:

defaultSubstitutions - A JSON object that specifies the default values to use for message variables in the message template. This parameter is required.

Returns:

this

See Also:

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

htmlPart

@Stability(Stable)
public CfnEmailTemplate.Builder htmlPart(String htmlPart)

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.

Parameters:

htmlPart - The message body, in HTML format, to use in email messages that are based on the message template. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnEmailTemplate.Builder tags(Object tags)

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

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

templateDescription

@Stability(Stable)
public CfnEmailTemplate.Builder templateDescription(String templateDescription)

A custom description of the message template.

Parameters:

templateDescription - A custom description of the message template. This parameter is required.

Returns:

this

See Also:

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

textPart

@Stability(Stable)
public CfnEmailTemplate.Builder textPart(String textPart)

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.

Parameters:

textPart - The message body, in plain text format, to use in email messages that are based on the message template. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnEmailTemplate build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEmailTemplate>

Returns:

a newly built instance of CfnEmailTemplate.