software.amazon.awscdk.services.pinpoint

Interface CfnSmsTemplateProps

All Known Implementing Classes:

CfnSmsTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.268Z")
public interface 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 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getBody

java.lang.String getBody()

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

getTemplateName

java.lang.String getTemplateName()

The name of the message template.

getDefaultSubstitutions

default java.lang.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.

getTags

default java.lang.Object getTags()

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

For more information, see Tag .

getTemplateDescription

default java.lang.String getTemplateDescription()

A custom description of the message template.

builder

static CfnSmsTemplateProps.Builder builder()

Returns:

a CfnSmsTemplateProps.Builder of CfnSmsTemplateProps