AWS::Pinpoint::Campaign Message - Amazon CloudFormation
SyntaxProperties
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).

AWS::Pinpoint::Campaign Message

Specifies the content and settings for a push notification that's sent to recipients of a campaign.

Syntax

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

JSON

{
  "Action" : String,
  "Body" : String,
  "ImageIconUrl" : String,
  "ImageSmallIconUrl" : String,
  "ImageUrl" : String,
  "JsonBody" : String,
  "MediaUrl" : String,
  "RawContent" : String,
  "SilentPush" : Boolean,
  "TimeToLive" : Integer,
  "Title" : String,
  "Url" : String
}

YAML

  Action: String
  Body: String
  ImageIconUrl: String
  ImageSmallIconUrl: String
  ImageUrl: String
  JsonBody: String
  MediaUrl: String
  RawContent: String
  SilentPush: Boolean
  TimeToLive: Integer
  Title: String
  Url: String

Properties

Action

The action to occur if a recipient taps the push notification. Valid values are:

  • OPEN_APP – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

  • DEEP_LINK – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

  • URL – The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

Required: No

Type: String

Update requires: No interruption

Body

The body of the notification message. The maximum number of characters is 200.

Required: No

Type: String

Update requires: No interruption

ImageIconUrl

The URL of the image to display as the push notification icon, such as the icon for the app.

Required: No

Type: String

Update requires: No interruption

ImageSmallIconUrl

The URL of the image to display as the small, push notification icon, such as a small version of the icon for the app.

Required: No

Type: String

Update requires: No interruption

ImageUrl

The URL of an image to display in the push notification.

Required: No

Type: String

Update requires: No interruption

JsonBody

The JSON payload to use for a silent push notification.

Required: No

Type: String

Update requires: No interruption

MediaUrl

The URL of the image or video to display in the push notification.

Required: No

Type: String

Update requires: No interruption

RawContent

The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.

Required: No

Type: String

Update requires: No interruption

SilentPush

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

Required: No

Type: Boolean

Update requires: No interruption

TimeToLive

The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

Required: No

Type: Integer

Update requires: No interruption

Title

The title to display above the notification message on a recipient's device.

Required: No

Type: String

Update requires: No interruption

Url

The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Required: No

Type: String

Update requires: No interruption