CfnSmsTemplateMixinProps

class aws_cdk.mixins_preview.aws_pinpoint.mixins.CfnSmsTemplateMixinProps(*, body=None, default_substitutions=None, tags=None, template_description=None, template_name=None)

Bases: object

Properties for CfnSmsTemplatePropsMixin.

Parameters:

  • body (Optional[str]) – The message body to use in text messages that are based on 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 (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.

  • template_name (Optional[str]) – The name of the message template to use for the message. 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

ExampleMetadata:

fixture=_generated

Example:

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

# tags: Any

cfn_sms_template_mixin_props = pinpoint_mixins.CfnSmsTemplateMixinProps(
    body="body",
    default_substitutions="defaultSubstitutions",
    tags=tags,
    template_description="templateDescription",
    template_name="templateName"
)

Attributes

body

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

See:

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

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.

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.

For more information, see Tag .

See:

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

template_description

A custom description of the message template.

See:

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

template_name

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

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