aws-cdk-lib.aws_pinpoint.CfnPushTemplate.DefaultPushNotificationTemplateProperty

interface DefaultPushNotificationTemplateProperty

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnPushTemplate.DefaultPushNotificationTemplateProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnPushTemplate_DefaultPushNotificationTemplateProperty
Javasoftware.amazon.awscdk.services.pinpoint.CfnPushTemplate.DefaultPushNotificationTemplateProperty
Pythonaws_cdk.aws_pinpoint.CfnPushTemplate.DefaultPushNotificationTemplateProperty
TypeScript aws-cdk-lib » aws_pinpoint » CfnPushTemplate » DefaultPushNotificationTemplateProperty

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pinpoint as pinpoint } from 'aws-cdk-lib';
const defaultPushNotificationTemplateProperty: pinpoint.CfnPushTemplate.DefaultPushNotificationTemplateProperty = {
  action: 'action',
  body: 'body',
  sound: 'sound',
  title: 'title',
  url: 'url',
};

Properties

NameTypeDescription
action?stringThe action to occur if a recipient taps a push notification that's based on the message template.
body?stringThe message body to use in push notifications that are based on the message template.
sound?stringThe sound to play when a recipient receives a push notification that's based on the message template.
title?stringThe title to use in push notifications that are based on the message template.
url?stringThe URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL .

action?

Type: string (optional)

The action to occur if a recipient taps a push notification that's based on the message template.

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 the iOS and Android platforms.
  • 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 message body to use in push notifications that are based on the message template.


sound?

Type: string (optional)

The sound to play when a recipient receives a push notification that's based on the message template.

You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/ .

For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.


title?

Type: string (optional)

The title to use in push notifications that are based on the message template.

This title appears 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 a push notification that's based on the message template and the value of the Action property is URL .