CfnSmsTemplateProps

class aws_cdk.aws_pinpoint.CfnSmsTemplateProps(*, body, template_name, default_substitutions=None, tags=None, template_description=None)

Bases: object

Properties for defining a CfnSmsTemplate.

Parameters
  • body (str) – The message body to use in text messages that are based on the message template.

  • template_name (str) – The name of the message template.

  • default_substitutions (Optional[str]) – 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 (Optional[Any]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • template_description (Optional[str]) – A custom description of the message template.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

# tags: Any

cfn_sms_template_props = pinpoint.CfnSmsTemplateProps(
    body="body",
    template_name="templateName",

    # the properties below are optional
    default_substitutions="defaultSubstitutions",
    tags=tags,
    template_description="templateDescription"
)

Attributes

body

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

Link

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

Return type

str

default_substitutions

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.

Link

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

Return type

Optional[str]

tags

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

For more information, see Tag .

Link

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

Return type

Any

template_description

A custom description of the message template.

Link

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

Return type

Optional[str]

template_name

The name of the message template.

Link

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

Return type

str