Class CfnPushTemplate
A CloudFormation AWS::Pinpoint::PushTemplate
.
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.AWS.Pinpoint.dll
Syntax (csharp)
public class CfnPushTemplate : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnPushTemplate
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Pinpoint::PushTemplate
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 cfnPushTemplate = new CfnPushTemplate(this, "MyCfnPushTemplate", 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
CfnPushTemplate(Construct, String, ICfnPushTemplateProps) | Create a new |
CfnPushTemplate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPushTemplate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
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. |
AttrArn | The Amazon Resource Name (ARN) of the message template. |
Baidu | The message template to use for the Baidu (Baidu Cloud Push) channel. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPushTemplate(Construct, String, ICfnPushTemplateProps)
Create a new AWS::Pinpoint::PushTemplate
.
public CfnPushTemplate(Construct scope, string id, ICfnPushTemplateProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnPushTemplateProps
- resource properties.
CfnPushTemplate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPushTemplate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPushTemplate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPushTemplate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Adm
The message template to use for the ADM (Amazon Device Messaging) channel.
public virtual object Adm { get; set; }
Property Value
System.Object
Remarks
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.
public virtual object Apns { get; set; }
Property Value
System.Object
Remarks
This message template overrides the default template for push notification channels ( Default
).
AttrArn
The Amazon Resource Name (ARN) of the message template.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
Baidu
The message template to use for the Baidu (Baidu Cloud Push) channel.
public virtual object Baidu { get; set; }
Property Value
System.Object
Remarks
This message template overrides the default template for push notification channels ( Default
).
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Default
The default message template to use for push notification channels.
public virtual object Default { get; set; }
Property Value
System.Object
Remarks
DefaultSubstitutions
A JSON object that specifies the default values to use for message variables in the message template.
public virtual string DefaultSubstitutions { get; set; }
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.
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 virtual object Gcm { get; set; }
Property Value
System.Object
Remarks
This message template overrides the default template for push notification channels ( Default
).
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
TemplateDescription
A custom description of the message template.
public virtual string TemplateDescription { get; set; }
Property Value
System.String
Remarks
TemplateName
The name of the message template.
public virtual string TemplateName { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>