Package software.amazon.awscdk.services.pinpoint

Interface CfnCampaign.MessageConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.MessageConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

@Stability(Stable)
public static interface CfnCampaign.MessageConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the message configuration settings for a campaign.

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 customConfig;
 MessageConfigurationProperty messageConfigurationProperty = MessageConfigurationProperty.builder()
         .admMessage(MessageProperty.builder()
                 .action("action")
                 .body("body")
                 .imageIconUrl("imageIconUrl")
                 .imageSmallIconUrl("imageSmallIconUrl")
                 .imageUrl("imageUrl")
                 .jsonBody("jsonBody")
                 .mediaUrl("mediaUrl")
                 .rawContent("rawContent")
                 .silentPush(false)
                 .timeToLive(123)
                 .title("title")
                 .url("url")
                 .build())
         .apnsMessage(MessageProperty.builder()
                 .action("action")
                 .body("body")
                 .imageIconUrl("imageIconUrl")
                 .imageSmallIconUrl("imageSmallIconUrl")
                 .imageUrl("imageUrl")
                 .jsonBody("jsonBody")
                 .mediaUrl("mediaUrl")
                 .rawContent("rawContent")
                 .silentPush(false)
                 .timeToLive(123)
                 .title("title")
                 .url("url")
                 .build())
         .baiduMessage(MessageProperty.builder()
                 .action("action")
                 .body("body")
                 .imageIconUrl("imageIconUrl")
                 .imageSmallIconUrl("imageSmallIconUrl")
                 .imageUrl("imageUrl")
                 .jsonBody("jsonBody")
                 .mediaUrl("mediaUrl")
                 .rawContent("rawContent")
                 .silentPush(false)
                 .timeToLive(123)
                 .title("title")
                 .url("url")
                 .build())
         .customMessage(CampaignCustomMessageProperty.builder()
                 .data("data")
                 .build())
         .defaultMessage(MessageProperty.builder()
                 .action("action")
                 .body("body")
                 .imageIconUrl("imageIconUrl")
                 .imageSmallIconUrl("imageSmallIconUrl")
                 .imageUrl("imageUrl")
                 .jsonBody("jsonBody")
                 .mediaUrl("mediaUrl")
                 .rawContent("rawContent")
                 .silentPush(false)
                 .timeToLive(123)
                 .title("title")
                 .url("url")
                 .build())
         .emailMessage(CampaignEmailMessageProperty.builder()
                 .body("body")
                 .fromAddress("fromAddress")
                 .htmlBody("htmlBody")
                 .title("title")
                 .build())
         .gcmMessage(MessageProperty.builder()
                 .action("action")
                 .body("body")
                 .imageIconUrl("imageIconUrl")
                 .imageSmallIconUrl("imageSmallIconUrl")
                 .imageUrl("imageUrl")
                 .jsonBody("jsonBody")
                 .mediaUrl("mediaUrl")
                 .rawContent("rawContent")
                 .silentPush(false)
                 .timeToLive(123)
                 .title("title")
                 .url("url")
                 .build())
         .inAppMessage(CampaignInAppMessageProperty.builder()
                 .content(List.of(InAppMessageContentProperty.builder()
                         .backgroundColor("backgroundColor")
                         .bodyConfig(InAppMessageBodyConfigProperty.builder()
                                 .alignment("alignment")
                                 .body("body")
                                 .textColor("textColor")
                                 .build())
                         .headerConfig(InAppMessageHeaderConfigProperty.builder()
                                 .alignment("alignment")
                                 .header("header")
                                 .textColor("textColor")
                                 .build())
                         .imageUrl("imageUrl")
                         .primaryBtn(InAppMessageButtonProperty.builder()
                                 .android(OverrideButtonConfigurationProperty.builder()
                                         .buttonAction("buttonAction")
                                         .link("link")
                                         .build())
                                 .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                         .backgroundColor("backgroundColor")
                                         .borderRadius(123)
                                         .buttonAction("buttonAction")
                                         .link("link")
                                         .text("text")
                                         .textColor("textColor")
                                         .build())
                                 .ios(OverrideButtonConfigurationProperty.builder()
                                         .buttonAction("buttonAction")
                                         .link("link")
                                         .build())
                                 .web(OverrideButtonConfigurationProperty.builder()
                                         .buttonAction("buttonAction")
                                         .link("link")
                                         .build())
                                 .build())
                         .secondaryBtn(InAppMessageButtonProperty.builder()
                                 .android(OverrideButtonConfigurationProperty.builder()
                                         .buttonAction("buttonAction")
                                         .link("link")
                                         .build())
                                 .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                         .backgroundColor("backgroundColor")
                                         .borderRadius(123)
                                         .buttonAction("buttonAction")
                                         .link("link")
                                         .text("text")
                                         .textColor("textColor")
                                         .build())
                                 .ios(OverrideButtonConfigurationProperty.builder()
                                         .buttonAction("buttonAction")
                                         .link("link")
                                         .build())
                                 .web(OverrideButtonConfigurationProperty.builder()
                                         .buttonAction("buttonAction")
                                         .link("link")
                                         .build())
                                 .build())
                         .build()))
                 .customConfig(customConfig)
                 .layout("layout")
                 .build())
         .smsMessage(CampaignSmsMessageProperty.builder()
                 .body("body")
                 .entityId("entityId")
                 .messageType("messageType")
                 .originationNumber("originationNumber")
                 .senderId("senderId")
                 .templateId("templateId")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCampaign.MessageConfigurationProperty.Builder	builder()
default Object	getAdmMessage()	The message that the campaign sends through the ADM (Amazon Device Messaging) channel.
default Object	getApnsMessage()	The message that the campaign sends through the APNs (Apple Push Notification service) channel.
default Object	getBaiduMessage()	The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.
default Object	getCustomMessage()	The message that the campaign sends through a custom channel, as specified by the delivery configuration ( CustomDeliveryConfiguration ) settings for the campaign.
default Object	getDefaultMessage()	The default message that the campaign sends through all the channels that are configured for the campaign.
default Object	getEmailMessage()	The message that the campaign sends through the email channel.
default Object	getGcmMessage()	The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
default Object	getInAppMessage()	The default message for the in-app messaging channel.
default Object	getSmsMessage()	The message that the campaign sends through the SMS channel.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdmMessage

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

The message that the campaign sends through the ADM (Amazon Device Messaging) channel.

If specified, this message overrides the default message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-admmessage

getApnsMessage

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

The message that the campaign sends through the APNs (Apple Push Notification service) channel.

If specified, this message overrides the default message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-apnsmessage

getBaiduMessage

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

The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.

If specified, this message overrides the default message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-baidumessage

getCustomMessage

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

The message that the campaign sends through a custom channel, as specified by the delivery configuration ( CustomDeliveryConfiguration ) settings for the campaign.

If specified, this message overrides the default message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-custommessage

getDefaultMessage

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

The default message that the campaign sends through all the channels that are configured for the campaign.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-defaultmessage

getEmailMessage

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

The message that the campaign sends through the email channel. If specified, this message overrides the default message.

The maximum email message size is 200 KB. You can use email templates to send larger email messages.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-emailmessage

getGcmMessage

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

The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

If specified, this message overrides the default message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-gcmmessage

getInAppMessage

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

The default message for the in-app messaging channel.

This message overrides the default message ( DefaultMessage ).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-inappmessage

getSmsMessage

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

The message that the campaign sends through the SMS channel.

If specified, this message overrides the default message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-smsmessage

builder

@Stability(Stable)
static CfnCampaign.MessageConfigurationProperty.Builder builder()

Returns:

a CfnCampaign.MessageConfigurationProperty.Builder of CfnCampaign.MessageConfigurationProperty