@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:39.231Z") public class CfnPushTemplate extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnPushTemplate(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getAdm()
The message template to use for the ADM (Amazon Device Messaging) channel.
|
java.lang.Object |
getApns()
The message template to use for the APNs (Apple Push Notification service) channel.
|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the message template.
|
java.lang.Object |
getBaidu()
The message template to use for the Baidu (Baidu Cloud Push) channel.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDefaultSubstitutions()
A JSON object that specifies the default values to use for message variables in the message template.
|
java.lang.Object |
getDefaultValue()
The default message template to use for push notification channels.
|
java.lang.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.
|
java.lang.String |
getTemplateDescription()
A custom description of the message template.
|
java.lang.String |
getTemplateName()
The name of the message template.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.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(java.lang.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(java.lang.String value)
A custom description of the message template.
|
void |
setTemplateName(java.lang.String value)
The name of the message template.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnPushTemplate(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnPushTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnPushTemplate(Construct scope, java.lang.String id, CfnPushTemplateProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getTemplateName()
public void setTemplateName(java.lang.String value)
public java.lang.Object getAdm()
This message template overrides the default template for push notification channels ( Default
).
public void setAdm(IResolvable value)
This message template overrides the default template for push notification channels ( Default
).
public void setAdm(CfnPushTemplate.AndroidPushNotificationTemplateProperty value)
This message template overrides the default template for push notification channels ( Default
).
public java.lang.Object getApns()
This message template overrides the default template for push notification channels ( Default
).
public void setApns(IResolvable value)
This message template overrides the default template for push notification channels ( Default
).
public void setApns(CfnPushTemplate.APNSPushNotificationTemplateProperty value)
This message template overrides the default template for push notification channels ( Default
).
public java.lang.Object getBaidu()
This message template overrides the default template for push notification channels ( Default
).
public void setBaidu(IResolvable value)
This message template overrides the default template for push notification channels ( Default
).
public void setBaidu(CfnPushTemplate.AndroidPushNotificationTemplateProperty value)
This message template overrides the default template for push notification channels ( Default
).
public java.lang.Object getDefaultValue()
public void setDefaultValue(IResolvable value)
public void setDefaultValue(CfnPushTemplate.DefaultPushNotificationTemplateProperty value)
public java.lang.String getDefaultSubstitutions()
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.
public void setDefaultSubstitutions(java.lang.String value)
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.
public java.lang.Object getGcm()
This message template overrides the default template for push notification channels ( Default
).
public void setGcm(IResolvable value)
This message template overrides the default template for push notification channels ( Default
).
public void setGcm(CfnPushTemplate.AndroidPushNotificationTemplateProperty value)
This message template overrides the default template for push notification channels ( Default
).
public java.lang.String getTemplateDescription()
public void setTemplateDescription(java.lang.String value)