interface CfnPushTemplateProps

Language	Type name
.NET	`Amazon.CDK.AWS.Pinpoint.CfnPushTemplateProps`
Java	`software.amazon.awscdk.services.pinpoint.CfnPushTemplateProps`
Python	`aws_cdk.aws_pinpoint.CfnPushTemplateProps`
TypeScript	`@aws-cdk/aws-pinpoint` » `CfnPushTemplateProps`

Properties for defining a CfnPushTemplate.

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';

declare const tags: any;
const cfnPushTemplateProps: pinpoint.CfnPushTemplateProps = {
  templateName: 'templateName',

  // the properties below are optional
  adm: {
    action: 'action',
    body: 'body',
    imageIconUrl: 'imageIconUrl',
    imageUrl: 'imageUrl',
    smallImageIconUrl: 'smallImageIconUrl',
    sound: 'sound',
    title: 'title',
    url: 'url',
  },
  apns: {
    action: 'action',
    body: 'body',
    mediaUrl: 'mediaUrl',
    sound: 'sound',
    title: 'title',
    url: 'url',
  },
  baidu: {
    action: 'action',
    body: 'body',
    imageIconUrl: 'imageIconUrl',
    imageUrl: 'imageUrl',
    smallImageIconUrl: 'smallImageIconUrl',
    sound: 'sound',
    title: 'title',
    url: 'url',
  },
  default: {
    action: 'action',
    body: 'body',
    sound: 'sound',
    title: 'title',
    url: 'url',
  },
  defaultSubstitutions: 'defaultSubstitutions',
  gcm: {
    action: 'action',
    body: 'body',
    imageIconUrl: 'imageIconUrl',
    imageUrl: 'imageUrl',
    smallImageIconUrl: 'smallImageIconUrl',
    sound: 'sound',
    title: 'title',
    url: 'url',
  },
  tags: tags,
  templateDescription: 'templateDescription',
};

Properties

Name	Type	Description
templateName	`string`	The name of the message template.
adm?	`IResolvable` `\|` `AndroidPushNotificationTemplateProperty`	The message template to use for the ADM (Amazon Device Messaging) channel.
apns?	`IResolvable` `\|` `APNSPushNotificationTemplateProperty`	The message template to use for the APNs (Apple Push Notification service) channel.
baidu?	`IResolvable` `\|` `AndroidPushNotificationTemplateProperty`	The message template to use for the Baidu (Baidu Cloud Push) channel.
default?	`IResolvable` `\|` `DefaultPushNotificationTemplateProperty`	The default message template to use for push notification channels.
defaultSubstitutions?	`string`	A JSON object that specifies the default values to use for message variables in the message template.
gcm?	`IResolvable` `\|` `AndroidPushNotificationTemplateProperty`	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.
tags?	`any`	An array of key-value pairs to apply to this resource.
templateDescription?	`string`	A custom description of the message template.

templateName

Type: string

The name of the message template.

adm?

Type: IResolvable | AndroidPushNotificationTemplateProperty (optional)

The message template to use for the ADM (Amazon Device Messaging) channel.

This message template overrides the default template for push notification channels ( Default ).

apns?

Type: IResolvable | APNSPushNotificationTemplateProperty (optional)

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 ).

baidu?

Type: IResolvable | AndroidPushNotificationTemplateProperty (optional)

The message template to use for the Baidu (Baidu Cloud Push) channel.

This message template overrides the default template for push notification channels ( Default ).

default?

Type: IResolvable | DefaultPushNotificationTemplateProperty (optional)

The default message template to use for push notification channels.

defaultSubstitutions?

Type: string (optional)

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.

gcm?

Type: IResolvable | AndroidPushNotificationTemplateProperty (optional)

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 ).

tags?

Type: any (optional)

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

For more information, see Tag .

templateDescription?

Type: string (optional)

A custom description of the message template.