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.

  • adm (Union[IResolvable, AndroidPushNotificationTemplateProperty, 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, 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, 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, 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, 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 (Optional[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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.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 ).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-adm

Return type

Union[IResolvable, AndroidPushNotificationTemplateProperty, None]

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-apns

Return type

Union[IResolvable, APNSPushNotificationTemplateProperty, None]

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-baidu

Return type

Union[IResolvable, AndroidPushNotificationTemplateProperty, None]

default

The default message template to use for push notification channels.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-default

Return type

Union[IResolvable, DefaultPushNotificationTemplateProperty, None]

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-defaultsubstitutions

Return type

Optional[str]

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-gcm

Return type

Union[IResolvable, AndroidPushNotificationTemplateProperty, None]

tags

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

For more information, see Tag .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-tags

Return type

Any

template_description

A custom description of the message template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-templatedescription

Return type

Optional[str]

template_name

The name of the message template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-templatename

Return type

str