Class CfnSmsTemplate.Builder
java.lang.Object
software.amazon.awscdk.services.pinpoint.CfnSmsTemplate.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSmsTemplate>
- Enclosing class:
CfnSmsTemplate
@Stability(Stable)
public static final class CfnSmsTemplate.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSmsTemplate>
A fluent builder for
CfnSmsTemplate
.-
Method Summary
Modifier and TypeMethodDescriptionThe message body to use in text messages that are based on the message template.build()
static CfnSmsTemplate.Builder
defaultSubstitutions
(String defaultSubstitutions) A JSON object that specifies the default values to use for message variables in the message template.An array of key-value pairs to apply to this resource.templateDescription
(String templateDescription) A custom description of the message template.templateName
(String templateName) The name of the message template to use for the message.
-
Method Details
-
create
@Stability(Stable) public static CfnSmsTemplate.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
CfnSmsTemplate.Builder
.
-
body
The message body to use in text messages that are based on the message template.- Parameters:
body
- The message body to use in text messages that are based on the message template. This parameter is required.- Returns:
this
- See Also:
-
templateName
The name of the message template to use for the message.If specified, this value must match the name of an existing message template.
- Parameters:
templateName
- The name of the message template to use for the message. This parameter is required.- Returns:
this
- See Also:
-
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:
-
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:
-
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:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnSmsTemplate>
- Returns:
- a newly built instance of
CfnSmsTemplate
.
-