Package software.amazon.awscdk.services.pinpoint

Interface CfnSmsTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSmsTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:20.610Z")
@Stability(Stable)
public interface CfnSmsTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSmsTemplate.

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.pinpoint.*;
 Object tags;
 CfnSmsTemplateProps cfnSmsTemplateProps = CfnSmsTemplateProps.builder()
         .body("body")
         .templateName("templateName")
         // the properties below are optional
         .defaultSubstitutions("defaultSubstitutions")
         .tags(tags)
         .templateDescription("templateDescription")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSmsTemplateProps.Builder	A builder for CfnSmsTemplateProps
static final class	CfnSmsTemplateProps.Jsii$Proxy	An implementation for CfnSmsTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnSmsTemplateProps.Builder	builder()
String	getBody()	The message body to use in text messages that are based on the message template.
default String	getDefaultSubstitutions()	A JSON object that specifies the default values to use for message variables in the message template.
default Object	getTags()	An array of key-value pairs to apply to this resource.
default String	getTemplateDescription()	A custom description of the message template.
String	getTemplateName()	The name of the message template to use for the message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBody

@Stability(Stable)
@NotNull
String getBody()

The message body to use in text messages that are based on the message template.

See Also:

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

getTemplateName

@Stability(Stable)
@NotNull
String getTemplateName()

The name of the message template to use for the message.

If specified, this value must match the name of an existing message template.

See Also:

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

getDefaultSubstitutions

@Stability(Stable)
@Nullable
default String getDefaultSubstitutions()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Object getTags()

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

For more information, see Tag .

See Also:

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

getTemplateDescription

@Stability(Stable)
@Nullable
default String getTemplateDescription()

A custom description of the message template.

See Also:

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

builder

@Stability(Stable)
static CfnSmsTemplateProps.Builder builder()

Returns:

a CfnSmsTemplateProps.Builder of CfnSmsTemplateProps