1.204.0

interface MessageProperty

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnCampaign.MessageProperty
Javasoftware.amazon.awscdk.services.pinpoint.CfnCampaign.MessageProperty
Pythonaws_cdk.aws_pinpoint.CfnCampaign.MessageProperty
TypeScript @aws-cdk/aws-pinpoint » CfnCampaign » MessageProperty

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pinpoint from '@aws-cdk/aws-pinpoint';
const messageProperty: pinpoint.CfnCampaign.MessageProperty = {
  action: 'action',
  body: 'body',
  imageIconUrl: 'imageIconUrl',
  imageSmallIconUrl: 'imageSmallIconUrl',
  imageUrl: 'imageUrl',
  jsonBody: 'jsonBody',
  mediaUrl: 'mediaUrl',
  rawContent: 'rawContent',
  silentPush: false,
  timeToLive: 123,
  title: 'title',
  url: 'url',
};

Properties

NameTypeDescription
action?stringThe action to occur if a recipient taps the push notification. Valid values are:.
body?stringThe body of the notification message.
imageIconUrl?stringThe URL of the image to display as the push notification icon, such as the icon for the app.
imageSmallIconUrl?stringThe URL of the image to display as the small, push notification icon, such as a small version of the icon for the app.
imageUrl?stringThe URL of an image to display in the push notification.
jsonBody?stringThe JSON payload to use for a silent push notification.
mediaUrl?stringThe URL of the image or video to display in the push notification.
rawContent?stringThe raw, JSON-formatted string to use as the payload for the notification message.
silentPush?boolean | IResolvableSpecifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.
timeToLive?numberThe number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time.
title?stringThe title to display above the notification message on a recipient's device.
url?stringThe 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 .

action?

Type: string (optional)

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.

body?

Type: string (optional)

The body of the notification message.

The maximum number of characters is 200.

imageIconUrl?

Type: string (optional)

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

imageSmallIconUrl?

Type: string (optional)

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

imageUrl?

Type: string (optional)

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

jsonBody?

Type: string (optional)

The JSON payload to use for a silent push notification.

mediaUrl?

Type: string (optional)

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

rawContent?

Type: string (optional)

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.

silentPush?

Type: boolean | IResolvable (optional)

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.

timeToLive?

Type: number (optional)

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.

title?

Type: string (optional)

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

url?

Type: string (optional)

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 .

← PreviousNext →