AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Pinpoint::SmsTemplate

CfnSmsTemplate

Creates a message template that you can use in messages that are sent through the SMS channel. 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.

Import

import { CfnSmsTemplate } from 'aws-cdk-lib/aws-pinpoint';

Or use the module namespace:

import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnSmsTemplate

Properties

Configuration passed to the constructor as CfnSmsTemplateProps.

bodyRequired
string

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

templateNameRequired
string

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

defaultSubstitutionsOptional
string

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.

tagsOptional
any

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

templateDescriptionOptional
string

A custom description of the message template.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter