CfnCampaign.MessageConfigurationProperty

All Known Implementing Classes:: CfnCampaign.MessageConfigurationProperty.Jsii$Proxy

Enclosing class:: CfnCampaign

public static interface CfnCampaign.MessageConfigurationProperty

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();

Nested Class Summary

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

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CfnCampaign.MessageConfigurationProperty.Builder`	`builder()`
`default java.lang.Object`	`getAdmMessage()` The message that the campaign sends through the ADM (Amazon Device Messaging) channel.
`default java.lang.Object`	`getApnsMessage()` The message that the campaign sends through the APNs (Apple Push Notification service) channel.
`default java.lang.Object`	`getBaiduMessage()` The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.
`default java.lang.Object`	`getCustomMessage()` The message that the campaign sends through a custom channel, as specified by the delivery configuration ( `CustomDeliveryConfiguration` ) settings for the campaign.
`default java.lang.Object`	`getDefaultMessage()` The default message that the campaign sends through all the channels that are configured for the campaign.
`default java.lang.Object`	`getEmailMessage()` The message that the campaign sends through the email channel.
`default java.lang.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 java.lang.Object`	`getInAppMessage()` The default message for the in-app messaging channel.
`default java.lang.Object`	`getSmsMessage()` The message that the campaign sends through the SMS channel.

- Method Detail
  - getAdmMessage
```
default java.lang.Object getAdmMessage()
```
    The message that the campaign sends through the ADM (Amazon Device Messaging) channel.
    If specified, this message overrides the default message.
  - getApnsMessage
```
default java.lang.Object getApnsMessage()
```
    The message that the campaign sends through the APNs (Apple Push Notification service) channel.
    If specified, this message overrides the default message.
  - getBaiduMessage
```
default java.lang.Object getBaiduMessage()
```
    The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.
    If specified, this message overrides the default message.
  - getCustomMessage
```
default java.lang.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.
  - getDefaultMessage
```
default java.lang.Object getDefaultMessage()
```
    The default message that the campaign sends through all the channels that are configured for the campaign.
  - getEmailMessage
```
default java.lang.Object getEmailMessage()
```
    The message that the campaign sends through the email channel.
    If specified, this message overrides the default message.
  - getGcmMessage
```
default java.lang.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.
  - getInAppMessage
```
default java.lang.Object getInAppMessage()
```
    The default message for the in-app messaging channel.
    This message overrides the default message ( DefaultMessage ).
  - getSmsMessage
```
default java.lang.Object getSmsMessage()
```
    The message that the campaign sends through the SMS channel.
    If specified, this message overrides the default message.
  - builder
```
static CfnCampaign.MessageConfigurationProperty.Builder builder()
```
    Returns:
    
    a CfnCampaign.MessageConfigurationProperty.Builder of CfnCampaign.MessageConfigurationProperty

Interface CfnCampaign.MessageConfigurationProperty

Nested Class Summary

Method Summary

Method Detail

getAdmMessage

getApnsMessage

getBaiduMessage

getCustomMessage

getDefaultMessage

getEmailMessage

getGcmMessage

getInAppMessage

getSmsMessage

builder