Package software.amazon.awscdk.services.pinpoint

Interface CfnPushTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPushTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-07T10:36:10.517Z")
@Stability(Stable)
public interface CfnPushTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPushTemplate.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 Object tags;
 CfnPushTemplateProps cfnPushTemplateProps = CfnPushTemplateProps.builder()
         .templateName("templateName")
         // the properties below are optional
         .adm(AndroidPushNotificationTemplateProperty.builder()
                 .action("action")
                 .body("body")
                 .imageIconUrl("imageIconUrl")
                 .imageUrl("imageUrl")
                 .smallImageIconUrl("smallImageIconUrl")
                 .sound("sound")
                 .title("title")
                 .url("url")
                 .build())
         .apns(APNSPushNotificationTemplateProperty.builder()
                 .action("action")
                 .body("body")
                 .mediaUrl("mediaUrl")
                 .sound("sound")
                 .title("title")
                 .url("url")
                 .build())
         .baidu(AndroidPushNotificationTemplateProperty.builder()
                 .action("action")
                 .body("body")
                 .imageIconUrl("imageIconUrl")
                 .imageUrl("imageUrl")
                 .smallImageIconUrl("smallImageIconUrl")
                 .sound("sound")
                 .title("title")
                 .url("url")
                 .build())
         .default(DefaultPushNotificationTemplateProperty.builder()
                 .action("action")
                 .body("body")
                 .sound("sound")
                 .title("title")
                 .url("url")
                 .build())
         .defaultSubstitutions("defaultSubstitutions")
         .gcm(AndroidPushNotificationTemplateProperty.builder()
                 .action("action")
                 .body("body")
                 .imageIconUrl("imageIconUrl")
                 .imageUrl("imageUrl")
                 .smallImageIconUrl("smallImageIconUrl")
                 .sound("sound")
                 .title("title")
                 .url("url")
                 .build())
         .tags(tags)
         .templateDescription("templateDescription")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPushTemplateProps.Builder	A builder for CfnPushTemplateProps
static final class	CfnPushTemplateProps.Jsii$Proxy	An implementation for CfnPushTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnPushTemplateProps.Builder	builder()
default Object	getAdm()	The message template to use for the ADM (Amazon Device Messaging) channel.
default Object	getApns()	The message template to use for the APNs (Apple Push Notification service) channel.
default Object	getBaidu()	The message template to use for the Baidu (Baidu Cloud Push) channel.
default String	getDefaultSubstitutions()	A JSON object that specifies the default values to use for message variables in the message template.
default Object	getDefaultValue()	The default message template to use for push notification channels.
default Object	getGcm()	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.
default Object	getTags()	An array of key-value pairs to apply to this resource.
default String	getTemplateDescription()	A custom description of the message template.
String	getTemplateName()	The name of the message template to use for the message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTemplateName

@Stability(Stable)
@NotNull
String getTemplateName()

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

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

See Also:

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

getAdm

@Stability(Stable)
@Nullable
default Object getAdm()

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

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

See Also:

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

getApns

@Stability(Stable)
@Nullable
default Object getApns()

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

See Also:

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

getBaidu

@Stability(Stable)
@Nullable
default Object getBaidu()

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

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

See Also:

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

getDefaultValue

@Stability(Stable)
@Nullable
default Object getDefaultValue()

The default message template to use for push notification channels.

See Also:

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

getDefaultSubstitutions

@Stability(Stable)
@Nullable
default String getDefaultSubstitutions()

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.

See Also:

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

getGcm

@Stability(Stable)
@Nullable
default Object getGcm()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Object getTags()

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

For more information, see Tag .

See Also:

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

getTemplateDescription

@Stability(Stable)
@Nullable
default String getTemplateDescription()

A custom description of the message template.

See Also:

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

builder

@Stability(Stable)
static CfnPushTemplateProps.Builder builder()

Returns:

a CfnPushTemplateProps.Builder of CfnPushTemplateProps