Package software.amazon.awscdk.services.pinpoint

Class CfnPushTemplate.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnPushTemplate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPushTemplate>

Enclosing class:

CfnPushTemplate

@Stability(Stable)
public static final class CfnPushTemplate.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPushTemplate>

A fluent builder for CfnPushTemplate.

Method Summary

Modifier and Type	Method	Description
CfnPushTemplate.Builder	adm(IResolvable adm)	The message template to use for the ADM (Amazon Device Messaging) channel.
CfnPushTemplate.Builder	adm(CfnPushTemplate.AndroidPushNotificationTemplateProperty adm)	The message template to use for the ADM (Amazon Device Messaging) channel.
CfnPushTemplate.Builder	apns(IResolvable apns)	The message template to use for the APNs (Apple Push Notification service) channel.
CfnPushTemplate.Builder	apns(CfnPushTemplate.APNSPushNotificationTemplateProperty apns)	The message template to use for the APNs (Apple Push Notification service) channel.
CfnPushTemplate.Builder	baidu(IResolvable baidu)	The message template to use for the Baidu (Baidu Cloud Push) channel.
CfnPushTemplate.Builder	baidu(CfnPushTemplate.AndroidPushNotificationTemplateProperty baidu)	The message template to use for the Baidu (Baidu Cloud Push) channel.
CfnPushTemplate	build()
static CfnPushTemplate.Builder	create(software.constructs.Construct scope, String id)
CfnPushTemplate.Builder	defaultSubstitutions(String defaultSubstitutions)	A JSON object that specifies the default values to use for message variables in the message template.
CfnPushTemplate.Builder	defaultValue(IResolvable defaultValue)	The default message template to use for push notification channels.
CfnPushTemplate.Builder	defaultValue(CfnPushTemplate.DefaultPushNotificationTemplateProperty defaultValue)	The default message template to use for push notification channels.
CfnPushTemplate.Builder	gcm(IResolvable 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.
CfnPushTemplate.Builder	gcm(CfnPushTemplate.AndroidPushNotificationTemplateProperty 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.
CfnPushTemplate.Builder	tags(Object tags)	An array of key-value pairs to apply to this resource.
CfnPushTemplate.Builder	templateDescription(String templateDescription)	A custom description of the message template.
CfnPushTemplate.Builder	templateName(String templateName)	The name of the message template to use for the message.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnPushTemplate.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnPushTemplate.Builder.

templateName

@Stability(Stable)
public CfnPushTemplate.Builder templateName(String templateName)

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

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

Parameters:

templateName - The name of the message template to use for the message. This parameter is required.

Returns:

this

See Also:

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

adm

@Stability(Stable)
public CfnPushTemplate.Builder adm(IResolvable adm)

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

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

Parameters:

adm - The message template to use for the ADM (Amazon Device Messaging) channel. This parameter is required.

Returns:

this

See Also:

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

adm

@Stability(Stable)
public CfnPushTemplate.Builder adm(CfnPushTemplate.AndroidPushNotificationTemplateProperty adm)

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

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

Parameters:

adm - The message template to use for the ADM (Amazon Device Messaging) channel. This parameter is required.

Returns:

this

See Also:

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

apns

@Stability(Stable)
public CfnPushTemplate.Builder apns(IResolvable apns)

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

Parameters:

apns - The message template to use for the APNs (Apple Push Notification service) channel. This parameter is required.

Returns:

this

See Also:

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

apns

@Stability(Stable)
public CfnPushTemplate.Builder apns(CfnPushTemplate.APNSPushNotificationTemplateProperty apns)

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

Parameters:

apns - The message template to use for the APNs (Apple Push Notification service) channel. This parameter is required.

Returns:

this

See Also:

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

baidu

@Stability(Stable)
public CfnPushTemplate.Builder baidu(IResolvable baidu)

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

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

Parameters:

baidu - The message template to use for the Baidu (Baidu Cloud Push) channel. This parameter is required.

Returns:

this

See Also:

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

baidu

@Stability(Stable)
public CfnPushTemplate.Builder baidu(CfnPushTemplate.AndroidPushNotificationTemplateProperty baidu)

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

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

Parameters:

baidu - The message template to use for the Baidu (Baidu Cloud Push) channel. This parameter is required.

Returns:

this

See Also:

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

defaultValue

@Stability(Stable)
public CfnPushTemplate.Builder defaultValue(IResolvable defaultValue)

The default message template to use for push notification channels.

Parameters:

defaultValue - The default message template to use for push notification channels. This parameter is required.

Returns:

this

See Also:

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

defaultValue

@Stability(Stable)
public CfnPushTemplate.Builder defaultValue(CfnPushTemplate.DefaultPushNotificationTemplateProperty defaultValue)

The default message template to use for push notification channels.

Parameters:

defaultValue - The default message template to use for push notification channels. This parameter is required.

Returns:

this

See Also:

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

defaultSubstitutions

@Stability(Stable)
public CfnPushTemplate.Builder defaultSubstitutions(String defaultSubstitutions)

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.

Parameters:

defaultSubstitutions - A JSON object that specifies the default values to use for message variables in the message template. This parameter is required.

Returns:

this

See Also:

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

gcm

@Stability(Stable)
public CfnPushTemplate.Builder gcm(IResolvable 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.

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

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

gcm

@Stability(Stable)
public CfnPushTemplate.Builder gcm(CfnPushTemplate.AndroidPushNotificationTemplateProperty 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.

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

Parameters:

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. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnPushTemplate.Builder tags(Object tags)

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

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

templateDescription

@Stability(Stable)
public CfnPushTemplate.Builder templateDescription(String templateDescription)

A custom description of the message template.

Parameters:

templateDescription - A custom description of the message template. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPushTemplate build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPushTemplate>

Returns:

a newly built instance of CfnPushTemplate.