@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:41.218Z") @Stability(value=Stable) public interface CfnCampaignProps extends software.amazon.jsii.JsiiSerializable
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;
Object tags;
CfnCampaignProps cfnCampaignProps = CfnCampaignProps.builder()
.applicationId("applicationId")
.name("name")
.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())
.segmentId("segmentId")
// the properties below are optional
.additionalTreatments(List.of(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()))
.campaignHook(CampaignHookProperty.builder()
.lambdaFunctionName("lambdaFunctionName")
.mode("mode")
.webUrl("webUrl")
.build())
.customDeliveryConfiguration(CustomDeliveryConfigurationProperty.builder()
.deliveryUri("deliveryUri")
.endpointTypes(List.of("endpointTypes"))
.build())
.description("description")
.holdoutPercent(123)
.isPaused(false)
.limits(LimitsProperty.builder()
.daily(123)
.maximumDuration(123)
.messagesPerSecond(123)
.session(123)
.total(123)
.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())
.priority(123)
.segmentVersion(123)
.tags(tags)
.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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnCampaignProps.Builder
A builder for
CfnCampaignProps |
static class |
CfnCampaignProps.Jsii$Proxy
An implementation for
CfnCampaignProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnCampaignProps.Builder |
builder() |
default Object |
getAdditionalTreatments()
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
|
String |
getApplicationId()
The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
|
default Object |
getCampaignHook()
Specifies the Lambda function to use as a code hook for a campaign.
|
default Object |
getCustomDeliveryConfiguration()
The delivery configuration settings for sending the treatment through a custom channel.
|
default String |
getDescription()
A custom description of the campaign.
|
default Number |
getHoldoutPercent()
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
default Object |
getIsPaused()
Specifies whether to pause the campaign.
|
default Object |
getLimits()
The messaging limits for the campaign.
|
default Object |
getMessageConfiguration()
The message configuration settings for the campaign.
|
String |
getName()
The name of the campaign.
|
default Number |
getPriority()
An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.
|
Object |
getSchedule()
The schedule settings for the campaign.
|
String |
getSegmentId()
The unique identifier for the segment to associate with the campaign.
|
default Number |
getSegmentVersion()
The version of the segment to associate with the campaign.
|
default Object |
getTags()
An array of key-value pairs to apply to this resource.
|
default Object |
getTemplateConfiguration()
The message template to use for the treatment.
|
default String |
getTreatmentDescription()
A custom description of the default treatment for the campaign.
|
default String |
getTreatmentName()
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
|
@Stability(value=Stable) @NotNull String getApplicationId()
@Stability(value=Stable) @NotNull String getName()
@Stability(value=Stable) @NotNull Object getSchedule()
@Stability(value=Stable) @NotNull String getSegmentId()
@Stability(value=Stable) @Nullable default Object getAdditionalTreatments()
@Stability(value=Stable) @Nullable default Object getCampaignHook()
@Stability(value=Stable) @Nullable default Object getCustomDeliveryConfiguration()
This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
@Stability(value=Stable) @Nullable default String getDescription()
@Stability(value=Stable) @Nullable default Number getHoldoutPercent()
@Stability(value=Stable) @Nullable default Object getIsPaused()
A paused campaign doesn't run unless you resume it by changing this value to false . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it.
@Stability(value=Stable) @Nullable default Object getLimits()
@Stability(value=Stable) @Nullable default Object getMessageConfiguration()
@Stability(value=Stable) @Nullable default Number getPriority()
If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.
@Stability(value=Stable) @Nullable default Number getSegmentVersion()
@Stability(value=Stable) @Nullable default Object getTags()
For more information, see Tag .
@Stability(value=Stable) @Nullable default Object getTemplateConfiguration()
@Stability(value=Stable) @Nullable default String getTreatmentDescription()
@Stability(value=Stable) @Nullable default String getTreatmentName()
A treatment is a variation of a campaign that's used for A/B testing.
@Stability(value=Stable) static CfnCampaignProps.Builder builder()
CfnCampaignProps.Builder of CfnCampaignPropsCopyright © 2022. All rights reserved.