Class CfnPushTemplateProps

Properties for defining a CfnPushTemplate.

Inheritance

object

CfnPushTemplateProps

Implements

ICfnPushTemplateProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPushTemplateProps : ICfnPushTemplateProps

Syntax (vb)

Public Class CfnPushTemplateProps Implements 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

Constructors

CfnPushTemplateProps()

Properties for defining a CfnPushTemplate.

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.

Constructors

CfnPushTemplateProps()

Properties for defining a CfnPushTemplate.

public CfnPushTemplateProps()

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"
             };

Properties

Adm

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

public object? Adm { get; set; }

Property Value

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

Type union: either IResolvable or CfnPushTemplate.IAndroidPushNotificationTemplateProperty

Apns

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

public object? Apns { get; set; }

Property Value

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

Type union: either IResolvable or CfnPushTemplate.IAPNSPushNotificationTemplateProperty

Baidu

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

public object? Baidu { get; set; }

Property Value

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

Type union: either IResolvable or CfnPushTemplate.IAndroidPushNotificationTemplateProperty

Default

The default message template to use for push notification channels.

public object? Default { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnPushTemplate.IDefaultPushNotificationTemplateProperty

DefaultSubstitutions

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

public string? DefaultSubstitutions { get; set; }

Property Value

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.

public object? Gcm { get; set; }

Property Value

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

Type union: either IResolvable or CfnPushTemplate.IAndroidPushNotificationTemplateProperty

Tags

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

public object? Tags { get; set; }

Property Value

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.

public string? TemplateDescription { get; set; }

Property Value

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.

public string TemplateName { get; set; }

Property Value

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

Implements

ICfnPushTemplateProps