All Superinterfaces:: software.amazon.jsii.JsiiSerializable

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

Enclosing class:: CfnCampaign

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

Specifies the settings for a campaign treatment.

A treatment is a variation of a campaign that's used for A/B testing of 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 attributes;
 Object customConfig;
 Object metrics;
 WriteTreatmentResourceProperty writeTreatmentResourceProperty = WriteTreatmentResourceProperty.builder()
         .customDeliveryConfiguration(CustomDeliveryConfigurationProperty.builder()
                 .deliveryUri("deliveryUri")
                 .endpointTypes(List.of("endpointTypes"))
                 .build())
         .messageConfiguration(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())
         .schedule(ScheduleProperty.builder()
                 .endTime("endTime")
                 .eventFilter(CampaignEventFilterProperty.builder()
                         .dimensions(EventDimensionsProperty.builder()
                                 .attributes(attributes)
                                 .eventType(SetDimensionProperty.builder()
                                         .dimensionType("dimensionType")
                                         .values(List.of("values"))
                                         .build())
                                 .metrics(metrics)
                                 .build())
                         .filterType("filterType")
                         .build())
                 .frequency("frequency")
                 .isLocalTime(false)
                 .quietTime(QuietTimeProperty.builder()
                         .end("end")
                         .start("start")
                         .build())
                 .startTime("startTime")
                 .timeZone("timeZone")
                 .build())
         .sizePercent(123)
         .templateConfiguration(TemplateConfigurationProperty.builder()
                 .emailTemplate(TemplateProperty.builder()
                         .name("name")
                         .version("version")
                         .build())
                 .pushTemplate(TemplateProperty.builder()
                         .name("name")
                         .version("version")
                         .build())
                 .smsTemplate(TemplateProperty.builder()
                         .name("name")
                         .version("version")
                         .build())
                 .voiceTemplate(TemplateProperty.builder()
                         .name("name")
                         .version("version")
                         .build())
                 .build())
         .treatmentDescription("treatmentDescription")
         .treatmentName("treatmentName")
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnCampaign.WriteTreatmentResourceProperty.Builder

A builder for CfnCampaign.WriteTreatmentResourceProperty

static final class

CfnCampaign.WriteTreatmentResourceProperty.Jsii$Proxy

An implementation for CfnCampaign.WriteTreatmentResourceProperty
Method Summary

Modifier and Type

Method

Description

static CfnCampaign.WriteTreatmentResourceProperty.Builder

builder()

default Object

getCustomDeliveryConfiguration()

The delivery configuration settings for sending the treatment through a custom channel.

default Object

getMessageConfiguration()

The message configuration settings for the treatment.

default Object

getSchedule()

The schedule settings for the treatment.

default Number

getSizePercent()

The allocated percentage of users (segment members) to send the treatment to.

default Object

getTemplateConfiguration()

The message template to use for the treatment.

default String

getTreatmentDescription()

A custom description of the treatment.

default String

getTreatmentName()

A custom name for the treatment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getCustomDeliveryConfiguration
  
  @Stability(Stable) @Nullable default Object getCustomDeliveryConfiguration()
  
  The delivery configuration settings for sending the treatment through a custom channel.
  This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
  Returns union: either IResolvable or CfnCampaign.CustomDeliveryConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-customdeliveryconfiguration
- getMessageConfiguration
  
  @Stability(Stable) @Nullable default Object getMessageConfiguration()
  
  The message configuration settings for the treatment.
  Returns union: either IResolvable or CfnCampaign.MessageConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-messageconfiguration
- getSchedule
  
  @Stability(Stable) @Nullable default Object getSchedule()
  
  The schedule settings for the treatment.
  Returns union: either IResolvable or CfnCampaign.ScheduleProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-schedule
- getSizePercent
  
  @Stability(Stable) @Nullable default Number getSizePercent()
  
  The allocated percentage of users (segment members) to send the treatment to.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-sizepercent
- getTemplateConfiguration
  
  @Stability(Stable) @Nullable default Object getTemplateConfiguration()
  
  The message template to use for the treatment.
  Returns union: either IResolvable or CfnCampaign.TemplateConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-templateconfiguration
- getTreatmentDescription
  
  @Stability(Stable) @Nullable default String getTreatmentDescription()
  
  A custom description of the treatment.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentdescription
- getTreatmentName
  
  @Stability(Stable) @Nullable default String getTreatmentName()
  
  A custom name for the treatment.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentname
- builder
  
  @Stability(Stable) static CfnCampaign.WriteTreatmentResourceProperty.Builder builder()
  
  Returns:
  
  a CfnCampaign.WriteTreatmentResourceProperty.Builder of CfnCampaign.WriteTreatmentResourceProperty

Interface CfnCampaign.WriteTreatmentResourceProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getCustomDeliveryConfiguration

getMessageConfiguration

getSchedule

getSizePercent

getTemplateConfiguration

getTreatmentDescription

getTreatmentName

builder