aws-cdk-lib.aws_pinpoint.CfnSmsTemplateProps

interface CfnSmsTemplateProps

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnSmsTemplateProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnSmsTemplateProps
Javasoftware.amazon.awscdk.services.pinpoint.CfnSmsTemplateProps
Pythonaws_cdk.aws_pinpoint.CfnSmsTemplateProps
TypeScript aws-cdk-lib » aws_pinpoint » CfnSmsTemplateProps

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 { aws_pinpoint as pinpoint } from 'aws-cdk-lib';

declare const tags: any;
const cfnSmsTemplateProps: pinpoint.CfnSmsTemplateProps = {
  body: 'body',
  templateName: 'templateName',

  // the properties below are optional
  defaultSubstitutions: 'defaultSubstitutions',
  tags: tags,
  templateDescription: 'templateDescription',
};

Properties

NameTypeDescription
bodystringThe message body to use in text messages that are based on the message template.
templateNamestringThe name of the message template.
defaultSubstitutions?stringA JSON object that specifies the default values to use for message variables in the message template.
tags?anyAn array of key-value pairs to apply to this resource.
templateDescription?stringA custom description of the message template.

body

Type: string

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


templateName

Type: string

The name of the message template.


defaultSubstitutions?

Type: string (optional)

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.


tags?

Type: any (optional)

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

For more information, see Tag .


templateDescription?

Type: string (optional)

A custom description of the message template.