AWS::Pinpoint::PushTemplate - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Pinpoint::PushTemplate

Creates a message template that you can use in messages that are sent through a push notification channel. A message template is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Pinpoint::PushTemplate",
  "Properties" : {
      "ADM" : AndroidPushNotificationTemplate,
      "APNS" : APNSPushNotificationTemplate,
      "Baidu" : AndroidPushNotificationTemplate,
      "Default" : DefaultPushNotificationTemplate,
      "DefaultSubstitutions" : String,
      "GCM" : AndroidPushNotificationTemplate,
      "Tags" : [ Tag, ... ],
      "TemplateDescription" : String,
      "TemplateName" : String
    }
}

Properties

ADM

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (Default).

Required: No

Type: AndroidPushNotificationTemplate

Update requires: No interruption

APNS

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (Default).

Required: No

Type: APNSPushNotificationTemplate

Update requires: No interruption

Baidu

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (Default).

Required: No

Type: AndroidPushNotificationTemplate

Update requires: No interruption

Default

The default message template to use for push notification channels.

Required: No

Type: DefaultPushNotificationTemplate

Update requires: No interruption

DefaultSubstitutions

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.

Required: No

Type: String

Update requires: No interruption

GCM

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (Default).

Required: No

Type: AndroidPushNotificationTemplate

Update requires: No interruption

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

TemplateDescription

A custom description of the message template.

Required: No

Type: String

Update requires: No interruption

TemplateName

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the message template (TemplateName).

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the message template.