@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:41.202Z") @Stability(value=Stable) public class CfnCampaign extends CfnResource implements IInspectable
Specifies the settings for a campaign. A campaign is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application.
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;
CfnCampaign cfnCampaign = CfnCampaign.Builder.create(this, "MyCfnCampaign")
.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 | Class and Description |
|---|---|
static interface |
CfnCampaign.AttributeDimensionProperty
Specifies attribute-based criteria for including or excluding endpoints from a segment.
|
static class |
CfnCampaign.Builder
A fluent builder for
CfnCampaign. |
static interface |
CfnCampaign.CampaignCustomMessageProperty
Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
|
static interface |
CfnCampaign.CampaignEmailMessageProperty
Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
|
static interface |
CfnCampaign.CampaignEventFilterProperty
Specifies the settings for events that cause a campaign to be sent.
|
static interface |
CfnCampaign.CampaignHookProperty
Specifies settings for invoking an Lambda function that customizes a segment for a campaign.
|
static interface |
CfnCampaign.CampaignInAppMessageProperty
Specifies the appearance of an in-app message, including the message type, the title and body text, text and background colors, and the configurations of buttons that appear in the message.
|
static interface |
CfnCampaign.CampaignSmsMessageProperty
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
|
static interface |
CfnCampaign.CustomDeliveryConfigurationProperty
Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel.
|
static interface |
CfnCampaign.DefaultButtonConfigurationProperty
Specifies the default behavior for a button that appears in an in-app message.
|
static interface |
CfnCampaign.EventDimensionsProperty
Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
|
static interface |
CfnCampaign.InAppMessageBodyConfigProperty
Specifies the configuration of main body text of the in-app message.
|
static interface |
CfnCampaign.InAppMessageButtonProperty
Specifies the configuration of a button that appears in an in-app message.
|
static interface |
CfnCampaign.InAppMessageContentProperty
Specifies the configuration and contents of an in-app message.
|
static interface |
CfnCampaign.InAppMessageHeaderConfigProperty
Specifies the configuration and content of the header or title text of the in-app message.
|
static interface |
CfnCampaign.LimitsProperty
Specifies the limits on the messages that a campaign can send.
|
static interface |
CfnCampaign.MessageConfigurationProperty
Specifies the message configuration settings for a campaign.
|
static interface |
CfnCampaign.MessageProperty
Specifies the content and settings for a push notification that's sent to recipients of a campaign.
|
static interface |
CfnCampaign.MetricDimensionProperty
Specifies metric-based criteria for including or excluding endpoints from a segment.
|
static interface |
CfnCampaign.OverrideButtonConfigurationProperty
Specifies the configuration of a button with settings that are specific to a certain device type.
|
static interface |
CfnCampaign.QuietTimeProperty
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
|
static interface |
CfnCampaign.ScheduleProperty
Specifies the schedule settings for a campaign.
|
static interface |
CfnCampaign.SetDimensionProperty
Specifies the dimension type and values for a segment dimension.
|
static interface |
CfnCampaign.TemplateConfigurationProperty
Specifies the message template to use for the message, for each type of channel.
|
static interface |
CfnCampaign.TemplateProperty
Specifies the name and version of the message template to use for the message.
|
static interface |
CfnCampaign.WriteTreatmentResourceProperty
Specifies the settings for a campaign treatment.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnCampaign(software.constructs.Construct scope,
String id,
CfnCampaignProps props)
Create a new `AWS::Pinpoint::Campaign`.
|
protected |
CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
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.
|
String |
getAttrArn()
The Amazon Resource Name (ARN) of the campaign.
|
String |
getAttrCampaignId()
The unique identifier for the campaign.
|
Object |
getCampaignHook()
Specifies the Lambda function to use as a code hook for a campaign.
|
protected Map<String,Object> |
getCfnProperties() |
Object |
getCustomDeliveryConfiguration()
The delivery configuration settings for sending the treatment through a custom channel.
|
String |
getDescription()
A custom description of the campaign.
|
Number |
getHoldoutPercent()
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
Object |
getIsPaused()
Specifies whether to pause the campaign.
|
Object |
getLimits()
The messaging limits for the campaign.
|
Object |
getMessageConfiguration()
The message configuration settings for the campaign.
|
String |
getName()
The name of the campaign.
|
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.
|
Number |
getSegmentVersion()
The version of the segment to associate with the campaign.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
Object |
getTemplateConfiguration()
The message template to use for the treatment.
|
String |
getTreatmentDescription()
A custom description of the default treatment for the campaign.
|
String |
getTreatmentName()
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setAdditionalTreatments(IResolvable value)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
|
void |
setAdditionalTreatments(List<Object> value)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
|
void |
setApplicationId(String value)
The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
|
void |
setCampaignHook(CfnCampaign.CampaignHookProperty value)
Specifies the Lambda function to use as a code hook for a campaign.
|
void |
setCampaignHook(IResolvable value)
Specifies the Lambda function to use as a code hook for a campaign.
|
void |
setCustomDeliveryConfiguration(CfnCampaign.CustomDeliveryConfigurationProperty value)
The delivery configuration settings for sending the treatment through a custom channel.
|
void |
setCustomDeliveryConfiguration(IResolvable value)
The delivery configuration settings for sending the treatment through a custom channel.
|
void |
setDescription(String value)
A custom description of the campaign.
|
void |
setHoldoutPercent(Number value)
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
void |
setIsPaused(Boolean value)
Specifies whether to pause the campaign.
|
void |
setIsPaused(IResolvable value)
Specifies whether to pause the campaign.
|
void |
setLimits(CfnCampaign.LimitsProperty value)
The messaging limits for the campaign.
|
void |
setLimits(IResolvable value)
The messaging limits for the campaign.
|
void |
setMessageConfiguration(CfnCampaign.MessageConfigurationProperty value)
The message configuration settings for the campaign.
|
void |
setMessageConfiguration(IResolvable value)
The message configuration settings for the campaign.
|
void |
setName(String value)
The name of the campaign.
|
void |
setPriority(Number value)
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.
|
void |
setSchedule(CfnCampaign.ScheduleProperty value)
The schedule settings for the campaign.
|
void |
setSchedule(IResolvable value)
The schedule settings for the campaign.
|
void |
setSegmentId(String value)
The unique identifier for the segment to associate with the campaign.
|
void |
setSegmentVersion(Number value)
The version of the segment to associate with the campaign.
|
void |
setTemplateConfiguration(CfnCampaign.TemplateConfigurationProperty value)
The message template to use for the treatment.
|
void |
setTemplateConfiguration(IResolvable value)
The message template to use for the treatment.
|
void |
setTreatmentDescription(String value)
A custom description of the default treatment for the campaign.
|
void |
setTreatmentName(String value)
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnCampaign(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnCampaign(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnCampaign(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnCampaignProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrCampaignId()
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
For more information, see Tag .
@Stability(value=Stable) @NotNull public String getApplicationId()
@Stability(value=Stable)
public void setApplicationId(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getName()
@Stability(value=Stable)
public void setName(@NotNull
String value)
@Stability(value=Stable) @NotNull public Object getSchedule()
@Stability(value=Stable)
public void setSchedule(@NotNull
CfnCampaign.ScheduleProperty value)
@Stability(value=Stable)
public void setSchedule(@NotNull
IResolvable value)
@Stability(value=Stable) @NotNull public String getSegmentId()
@Stability(value=Stable)
public void setSegmentId(@NotNull
String value)
@Stability(value=Stable) @Nullable public Object getAdditionalTreatments()
@Stability(value=Stable)
public void setAdditionalTreatments(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setAdditionalTreatments(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public Object getCampaignHook()
@Stability(value=Stable)
public void setCampaignHook(@Nullable
CfnCampaign.CampaignHookProperty value)
@Stability(value=Stable)
public void setCampaignHook(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getCustomDeliveryConfiguration()
This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
@Stability(value=Stable)
public void setCustomDeliveryConfiguration(@Nullable
CfnCampaign.CustomDeliveryConfigurationProperty value)
This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
@Stability(value=Stable)
public void setCustomDeliveryConfiguration(@Nullable
IResolvable value)
This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
@Stability(value=Stable) @Nullable public String getDescription()
@Stability(value=Stable)
public void setDescription(@Nullable
String value)
@Stability(value=Stable) @Nullable public Number getHoldoutPercent()
@Stability(value=Stable)
public void setHoldoutPercent(@Nullable
Number value)
@Stability(value=Stable) @Nullable public 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)
public void setIsPaused(@Nullable
Boolean value)
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)
public void setIsPaused(@Nullable
IResolvable value)
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 public Object getLimits()
@Stability(value=Stable)
public void setLimits(@Nullable
CfnCampaign.LimitsProperty value)
@Stability(value=Stable)
public void setLimits(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public Object getMessageConfiguration()
@Stability(value=Stable)
public void setMessageConfiguration(@Nullable
CfnCampaign.MessageConfigurationProperty value)
@Stability(value=Stable)
public void setMessageConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public 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)
public void setPriority(@Nullable
Number value)
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 public Number getSegmentVersion()
@Stability(value=Stable)
public void setSegmentVersion(@Nullable
Number value)
@Stability(value=Stable) @Nullable public Object getTemplateConfiguration()
@Stability(value=Stable)
public void setTemplateConfiguration(@Nullable
CfnCampaign.TemplateConfigurationProperty value)
@Stability(value=Stable)
public void setTemplateConfiguration(@Nullable
IResolvable value)
@Stability(value=Stable) @Nullable public String getTreatmentDescription()
@Stability(value=Stable)
public void setTreatmentDescription(@Nullable
String value)
@Stability(value=Stable) @Nullable public String getTreatmentName()
A treatment is a variation of a campaign that's used for A/B testing.
@Stability(value=Stable)
public void setTreatmentName(@Nullable
String value)
A treatment is a variation of a campaign that's used for A/B testing.
Copyright © 2022. All rights reserved.