Class CfnPushTemplate

Creates a message template that you can use in messages that are sent through a push notification channel.

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnPushTemplate

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(Object)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<ResolutionTypeHint>)

CfnResource.GetMetadata(String)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnPushTemplate : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnPushTemplate
    Inherits CfnResource
    Implements IInspectable, ITaggable

Remarks

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.

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

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(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
CfnPushTemplate(Construct, String, ICfnPushTemplateProps)

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.
AttrId
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	Tag Manager which manages the tags for this resource.
TagsRaw	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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

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

CfnPushTemplate(Construct, String, ICfnPushTemplateProps)

public CfnPushTemplate(Construct scope, string id, ICfnPushTemplateProps props)

Parameters

scope Constructs.Construct: Scope in which this resource is defined.
id System.String: Construct identifier for this resource (unique in its scope).
props ICfnPushTemplateProps: Resource properties.

Properties

Adm

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

public virtual object Adm { get; set; }

Property Value

System.Object

Apns

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

public virtual object Apns { get; set; }

Property Value

System.Object

AttrArn

The Amazon Resource Name (ARN) of the message template.

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrId

public virtual string AttrId { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Id

Baidu

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

public virtual object Baidu { get; set; }

Property Value

System.Object

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

CfnResource.CfnProperties

Default

The default message template to use for push notification channels.

public virtual object Default { get; set; }

Property Value

System.Object

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

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

TagsRaw

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

public virtual object TagsRaw { get; set; }

Property Value

System.Object

TemplateDescription

A custom description of the message template.

public virtual string TemplateDescription { get; set; }

Property Value

System.String

TemplateName

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

public virtual string TemplateName { get; set; }

Property Value

System.String

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable

ITaggable