aws-cdk-lib.aws_pinpoint.CfnPushTemplate.APNSPushNotificationTemplateProperty

interface APNSPushNotificationTemplateProperty

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

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) 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 aPNSPushNotificationTemplateProperty: pinpoint.CfnPushTemplate.APNSPushNotificationTemplateProperty = {
  action: 'action',
  body: 'body',
  mediaUrl: 'mediaUrl',
  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.
mediaUrl?stringThe URL of an image or video to display in push notifications that are based on the message template.
sound?stringThe key for the sound to play when the 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 the 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 platform.
  • 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.


mediaUrl?

Type: string (optional)

The URL of an image or video to display in push notifications that are based on the message template.


sound?

Type: string (optional)

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

The value for this key is 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 the 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 .