Interface ICfnSmsTemplateProps

Properties for defining a CfnSmsTemplate.

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnSmsTemplateProps

Syntax (vb)

Public Interface ICfnSmsTemplateProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Pinpoint;

             var tags;

             var cfnSmsTemplateProps = new CfnSmsTemplateProps {
                 Body = "body",
                 TemplateName = "templateName",

                 // the properties below are optional
                 DefaultSubstitutions = "defaultSubstitutions",
                 Tags = tags,
                 TemplateDescription = "templateDescription"
             };

Synopsis

Properties

Body	The message body to use in text messages that are based on the message template.
DefaultSubstitutions	A JSON object that specifies the default values to use for message variables in the message template.
Tags	An array of key-value pairs to apply to this resource.
TemplateDescription	A custom description of the message template.
TemplateName	The name of the message template to use for the message.

Properties

Body

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

string Body { get; }

Property Value

string

Remarks

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

DefaultSubstitutions

A JSON object that specifies the default values to use for message variables in the message template.

string? DefaultSubstitutions { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-defaultsubstitutions

Tags

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

object? Tags { get; }

Property Value

object

Remarks

For more information, see Tag .

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

TemplateDescription

A custom description of the message template.

string? TemplateDescription { get; }

Property Value

string

Remarks

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

TemplateName

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

string TemplateName { get; }

Property Value

string

Remarks

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

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