AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Pinpoint::PushTemplate

CfnPushTemplate

Creates a message template that you can use in messages that are sent through a push notification channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

Import

import { CfnPushTemplate } from 'aws-cdk-lib/aws-pinpoint';

Or use the module namespace:

import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnPushTemplate

Properties

Configuration passed to the constructor as CfnPushTemplateProps.

templateNameRequired
string

The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

admOptional
IResolvable | AndroidPushNotificationTemplateProperty

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels ( `Default` ).

apnsOptional
IResolvable | APNSPushNotificationTemplateProperty

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

baiduOptional
IResolvable | AndroidPushNotificationTemplateProperty

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels ( `Default` ).

defaultOptional
IResolvable | DefaultPushNotificationTemplateProperty

The default message template to use for push notification channels.

defaultSubstitutionsOptional
string

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.

gcmOptional
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. This message template overrides the default template for push notification channels ( `Default` ).

tagsOptional
any

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

templateDescriptionOptional
string

A custom description of the message template.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Pinpoint::PushTemplateView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-pinpoint
CFN TypeAWS::Pinpoint::PushTemplate
Properties9

Related Constructs

Explore This Service

External Links