Interface CfnCampaign.WriteTreatmentResourceProperty
- 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();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnCampaign.WriteTreatmentResourceProperty
static final class
An implementation forCfnCampaign.WriteTreatmentResourceProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
CfnCampaign.WriteTreatmentResourceProperty.CustomDeliveryConfiguration
.default Object
The message configuration settings for the treatment.default Object
The schedule settings for the treatment.default Number
The allocated percentage of users (segment members) to send the treatment to.default Object
CfnCampaign.WriteTreatmentResourceProperty.TemplateConfiguration
.default String
A custom description of the treatment.default String
A custom name for the treatment.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCustomDeliveryConfiguration
CfnCampaign.WriteTreatmentResourceProperty.CustomDeliveryConfiguration
. -
getMessageConfiguration
The message configuration settings for the treatment. -
getSchedule
The schedule settings for the treatment. -
getSizePercent
The allocated percentage of users (segment members) to send the treatment to. -
getTemplateConfiguration
CfnCampaign.WriteTreatmentResourceProperty.TemplateConfiguration
. -
getTreatmentDescription
A custom description of the treatment. -
getTreatmentName
A custom name for the treatment. -
builder
-