Package software.amazon.awscdk.cfnpropertymixins.services.pinpoint

Class CfnPushTemplatePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.pinpoint.CfnPushTemplatePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPushTemplatePropsMixin>

Enclosing class:

CfnPushTemplatePropsMixin

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

A fluent builder for CfnPushTemplatePropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnPushTemplatePropsMixin.Builder.

create

@Stability(Stable)
public static CfnPushTemplatePropsMixin.Builder create()

Returns:

a new instance of CfnPushTemplatePropsMixin.Builder.

adm

@Stability(Stable)
public CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.Builder adm(CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.Builder apns(CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.Builder baidu(CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.Builder defaultValue(CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.Builder gcm(CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.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 CfnPushTemplatePropsMixin.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

templateName

@Stability(Stable)
public CfnPushTemplatePropsMixin.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

build

@Stability(Stable)
public CfnPushTemplatePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnPushTemplatePropsMixin.