CfnPushTemplateProps
- class aws_cdk.aws_pinpoint.CfnPushTemplateProps(*, template_name, adm=None, apns=None, baidu=None, default=None, default_substitutions=None, gcm=None, tags=None, template_description=None)
Bases:
object
Properties for defining a
CfnPushTemplate
.- Parameters:
template_name (
str
) – The name of the message template to use for the message. If specified, this value must match the name of an existing message template.adm (
Union
[IResolvable
,AndroidPushNotificationTemplateProperty
,Dict
[str
,Any
],None
]) – 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 (
Union
[IResolvable
,APNSPushNotificationTemplateProperty
,Dict
[str
,Any
],None
]) – 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 (
Union
[IResolvable
,AndroidPushNotificationTemplateProperty
,Dict
[str
,Any
],None
]) – 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 (
Union
[IResolvable
,DefaultPushNotificationTemplateProperty
,Dict
[str
,Any
],None
]) – The default message template to use for push notification channels.default_substitutions (
Optional
[str
]) – 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 (
Union
[IResolvable
,AndroidPushNotificationTemplateProperty
,Dict
[str
,Any
],None
]) – 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 (
Any
) – An array of key-value pairs to apply to this resource. For more information, see Tag .template_description (
Optional
[str
]) – A custom description of the message template.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_pinpoint as pinpoint # tags: Any cfn_push_template_props = pinpoint.CfnPushTemplateProps( template_name="templateName", # the properties below are optional adm=pinpoint.CfnPushTemplate.AndroidPushNotificationTemplateProperty( action="action", body="body", image_icon_url="imageIconUrl", image_url="imageUrl", small_image_icon_url="smallImageIconUrl", sound="sound", title="title", url="url" ), apns=pinpoint.CfnPushTemplate.APNSPushNotificationTemplateProperty( action="action", body="body", media_url="mediaUrl", sound="sound", title="title", url="url" ), baidu=pinpoint.CfnPushTemplate.AndroidPushNotificationTemplateProperty( action="action", body="body", image_icon_url="imageIconUrl", image_url="imageUrl", small_image_icon_url="smallImageIconUrl", sound="sound", title="title", url="url" ), default=pinpoint.CfnPushTemplate.DefaultPushNotificationTemplateProperty( action="action", body="body", sound="sound", title="title", url="url" ), default_substitutions="defaultSubstitutions", gcm=pinpoint.CfnPushTemplate.AndroidPushNotificationTemplateProperty( action="action", body="body", image_icon_url="imageIconUrl", image_url="imageUrl", small_image_icon_url="smallImageIconUrl", sound="sound", title="title", url="url" ), tags=tags, template_description="templateDescription" )
Attributes
- adm
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
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
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
The default message template to use for push notification channels.
- default_substitutions
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
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
).
- template_description
A custom description of the message template.
- template_name
The name of the message template to use for the message.
If specified, this value must match the name of an existing message template.