Interface ICfnPushTemplateProps

Properties for defining a CfnPushTemplate.

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnPushTemplateProps

Syntax (vb)

Public Interface ICfnPushTemplateProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;

var tags;

var cfnPushTemplateProps = new CfnPushTemplateProps {
    TemplateName = "templateName",

    // the properties below are optional
    Adm = new AndroidPushNotificationTemplateProperty {
        Action = "action",
        Body = "body",
        ImageIconUrl = "imageIconUrl",
        ImageUrl = "imageUrl",
        SmallImageIconUrl = "smallImageIconUrl",
        Sound = "sound",
        Title = "title",
        Url = "url"
    },
    Apns = new APNSPushNotificationTemplateProperty {
        Action = "action",
        Body = "body",
        MediaUrl = "mediaUrl",
        Sound = "sound",
        Title = "title",
        Url = "url"
    },
    Baidu = new AndroidPushNotificationTemplateProperty {
        Action = "action",
        Body = "body",
        ImageIconUrl = "imageIconUrl",
        ImageUrl = "imageUrl",
        SmallImageIconUrl = "smallImageIconUrl",
        Sound = "sound",
        Title = "title",
        Url = "url"
    },
    Default = new DefaultPushNotificationTemplateProperty {
        Action = "action",
        Body = "body",
        Sound = "sound",
        Title = "title",
        Url = "url"
    },
    DefaultSubstitutions = "defaultSubstitutions",
    Gcm = new AndroidPushNotificationTemplateProperty {
        Action = "action",
        Body = "body",
        ImageIconUrl = "imageIconUrl",
        ImageUrl = "imageUrl",
        SmallImageIconUrl = "smallImageIconUrl",
        Sound = "sound",
        Title = "title",
        Url = "url"
    },
    Tags = tags,
    TemplateDescription = "templateDescription"
};

Synopsis

Properties

Adm	The message template to use for the ADM (Amazon Device Messaging) channel.
Apns	The message template to use for the APNs (Apple Push Notification service) channel.
Baidu	The message template to use for the Baidu (Baidu Cloud Push) channel.
Default	The default message template to use for push notification channels.
DefaultSubstitutions	A JSON object that specifies the default values to use for message variables in the message template.
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.
Tags	An array of key-value pairs to apply to this resource.
TemplateDescription	A custom description of the message template.
TemplateName	The name of the message template to use for the message.

Properties

Adm

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

virtual object Adm { get; }

Property Value

System.Object

Remarks

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

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

Apns

The message template to use for the APNs (Apple Push Notification service) channel.

virtual object Apns { get; }

Property Value

System.Object

Remarks

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

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

Baidu

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

virtual object Baidu { get; }

Property Value

System.Object

Remarks

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

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

Default

The default message template to use for push notification channels.

virtual object Default { get; }

Property Value

System.Object

Remarks

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

DefaultSubstitutions

A JSON object that specifies the default values to use for message variables in the message template.

virtual string DefaultSubstitutions { get; }

Property Value

System.String

Remarks

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.

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

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.

virtual object Gcm { get; }

Property Value

System.Object

Remarks

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

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

Tags

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

virtual object Tags { get; }

Property Value

System.Object

Remarks

For more information, see Tag .

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

TemplateDescription

A custom description of the message template.

virtual string TemplateDescription { get; }

Property Value

System.String

Remarks

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

TemplateName

The name of the message template to use for the message.

string TemplateName { get; }

Property Value

System.String

Remarks

If specified, this value must match the name of an existing message template.

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