software.amazon.awscdk.services.pinpoint

Class CfnPushTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpoint.CfnPushTemplate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.237Z")
 @Stability(value=Stable)
public class CfnPushTemplate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::PushTemplate`.

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.

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;
 CfnPushTemplate cfnPushTemplate = CfnPushTemplate.Builder.create(this, "MyCfnPushTemplate")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnPushTemplate.AndroidPushNotificationTemplateProperty Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.
static interface	CfnPushTemplate.APNSPushNotificationTemplateProperty Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.
static class	CfnPushTemplate.Builder A fluent builder for CfnPushTemplate.
static interface	CfnPushTemplate.DefaultPushNotificationTemplateProperty Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPushTemplate(software.constructs.Construct scope, String id, CfnPushTemplateProps props) Create a new `AWS::Pinpoint::PushTemplate`.
protected	CfnPushTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPushTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAdm() The message template to use for the ADM (Amazon Device Messaging) channel.
Object	getApns() The message template to use for the APNs (Apple Push Notification service) channel.
String	getAttrArn() The Amazon Resource Name (ARN) of the message template.
Object	getBaidu() The message template to use for the Baidu (Baidu Cloud Push) channel.
protected Map<String,Object>	getCfnProperties()
String	getDefaultSubstitutions() A JSON object that specifies the default values to use for message variables in the message template.
Object	getDefaultValue() The default message template to use for push notification channels.
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.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getTemplateDescription() A custom description of the message template.
String	getTemplateName() The name of the message template.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdm(CfnPushTemplate.AndroidPushNotificationTemplateProperty value) The message template to use for the ADM (Amazon Device Messaging) channel.
void	setAdm(IResolvable value) The message template to use for the ADM (Amazon Device Messaging) channel.
void	setApns(CfnPushTemplate.APNSPushNotificationTemplateProperty value) The message template to use for the APNs (Apple Push Notification service) channel.
void	setApns(IResolvable value) The message template to use for the APNs (Apple Push Notification service) channel.
void	setBaidu(CfnPushTemplate.AndroidPushNotificationTemplateProperty value) The message template to use for the Baidu (Baidu Cloud Push) channel.
void	setBaidu(IResolvable value) The message template to use for the Baidu (Baidu Cloud Push) channel.
void	setDefaultSubstitutions(String value) A JSON object that specifies the default values to use for message variables in the message template.
void	setDefaultValue(CfnPushTemplate.DefaultPushNotificationTemplateProperty value) The default message template to use for push notification channels.
void	setDefaultValue(IResolvable value) The default message template to use for push notification channels.
void	setGcm(CfnPushTemplate.AndroidPushNotificationTemplateProperty value) 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.
void	setGcm(IResolvable value) 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.
void	setTemplateDescription(String value) A custom description of the message template.
void	setTemplateName(String value) The name of the message template.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPushTemplate

protected CfnPushTemplate(software.amazon.jsii.JsiiObjectRef objRef)

CfnPushTemplate

protected CfnPushTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPushTemplate

@Stability(value=Stable)
public CfnPushTemplate(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnPushTemplateProps props)

Create a new `AWS::Pinpoint::PushTemplate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getTemplateName

@Stability(value=Stable)
 @NotNull
public String getTemplateName()

The name of the message template.

setTemplateName

@Stability(value=Stable)
public void setTemplateName(@NotNull
                                                     String value)

The name of the message template.

getAdm

@Stability(value=Stable)
 @Nullable
public 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 ).

setAdm

@Stability(value=Stable)
public void setAdm(@Nullable
                                            CfnPushTemplate.AndroidPushNotificationTemplateProperty value)

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

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

setAdm

@Stability(value=Stable)
public void setAdm(@Nullable
                                            IResolvable value)

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

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

getApns

@Stability(value=Stable)
 @Nullable
public 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 ).

setApns

@Stability(value=Stable)
public void setApns(@Nullable
                                             CfnPushTemplate.APNSPushNotificationTemplateProperty value)

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

setApns

@Stability(value=Stable)
public void setApns(@Nullable
                                             IResolvable value)

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

getBaidu

@Stability(value=Stable)
 @Nullable
public 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 ).

setBaidu

@Stability(value=Stable)
public void setBaidu(@Nullable
                                              CfnPushTemplate.AndroidPushNotificationTemplateProperty value)

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

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

setBaidu

@Stability(value=Stable)
public void setBaidu(@Nullable
                                              IResolvable value)

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

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

getDefaultValue

@Stability(value=Stable)
 @Nullable
public Object getDefaultValue()

The default message template to use for push notification channels.

setDefaultValue

@Stability(value=Stable)
public void setDefaultValue(@Nullable
                                                     CfnPushTemplate.DefaultPushNotificationTemplateProperty value)

The default message template to use for push notification channels.

setDefaultValue

@Stability(value=Stable)
public void setDefaultValue(@Nullable
                                                     IResolvable value)

The default message template to use for push notification channels.

getDefaultSubstitutions

@Stability(value=Stable)
 @Nullable
public 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.

setDefaultSubstitutions

@Stability(value=Stable)
public void setDefaultSubstitutions(@Nullable
                                                             String value)

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.

getGcm

@Stability(value=Stable)
 @Nullable
public 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 ).

setGcm

@Stability(value=Stable)
public void setGcm(@Nullable
                                            CfnPushTemplate.AndroidPushNotificationTemplateProperty value)

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

setGcm

@Stability(value=Stable)
public void setGcm(@Nullable
                                            IResolvable value)

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

getTemplateDescription

@Stability(value=Stable)
 @Nullable
public String getTemplateDescription()

A custom description of the message template.

setTemplateDescription

@Stability(value=Stable)
public void setTemplateDescription(@Nullable
                                                            String value)

A custom description of the message template.