public static final class CfnCampaign.Builder
extends java.lang.Object
CfnCampaign
.Modifier and Type | Method and Description |
---|---|
CfnCampaign.Builder |
additionalTreatments(IResolvable additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
|
CfnCampaign.Builder |
additionalTreatments(java.util.List<? extends java.lang.Object> additionalTreatments)
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
|
CfnCampaign.Builder |
applicationId(java.lang.String applicationId)
The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
|
CfnCampaign |
build() |
CfnCampaign.Builder |
campaignHook(CfnCampaign.CampaignHookProperty campaignHook)
Specifies the Lambda function to use as a code hook for a campaign.
|
CfnCampaign.Builder |
campaignHook(IResolvable campaignHook)
Specifies the Lambda function to use as a code hook for a campaign.
|
static CfnCampaign.Builder |
create(Construct scope,
java.lang.String id) |
CfnCampaign.Builder |
customDeliveryConfiguration(CfnCampaign.CustomDeliveryConfigurationProperty customDeliveryConfiguration)
The delivery configuration settings for sending the treatment through a custom channel.
|
CfnCampaign.Builder |
customDeliveryConfiguration(IResolvable customDeliveryConfiguration)
The delivery configuration settings for sending the treatment through a custom channel.
|
CfnCampaign.Builder |
description(java.lang.String description)
A custom description of the campaign.
|
CfnCampaign.Builder |
holdoutPercent(java.lang.Number holdoutPercent)
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
|
CfnCampaign.Builder |
isPaused(java.lang.Boolean isPaused)
Specifies whether to pause the campaign.
|
CfnCampaign.Builder |
isPaused(IResolvable isPaused)
Specifies whether to pause the campaign.
|
CfnCampaign.Builder |
limits(CfnCampaign.LimitsProperty limits)
The messaging limits for the campaign.
|
CfnCampaign.Builder |
limits(IResolvable limits)
The messaging limits for the campaign.
|
CfnCampaign.Builder |
messageConfiguration(CfnCampaign.MessageConfigurationProperty messageConfiguration)
The message configuration settings for the campaign.
|
CfnCampaign.Builder |
messageConfiguration(IResolvable messageConfiguration)
The message configuration settings for the campaign.
|
CfnCampaign.Builder |
name(java.lang.String name)
The name of the campaign.
|
CfnCampaign.Builder |
priority(java.lang.Number priority)
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.
|
CfnCampaign.Builder |
schedule(CfnCampaign.ScheduleProperty schedule)
The schedule settings for the campaign.
|
CfnCampaign.Builder |
schedule(IResolvable schedule)
The schedule settings for the campaign.
|
CfnCampaign.Builder |
segmentId(java.lang.String segmentId)
The unique identifier for the segment to associate with the campaign.
|
CfnCampaign.Builder |
segmentVersion(java.lang.Number segmentVersion)
The version of the segment to associate with the campaign.
|
CfnCampaign.Builder |
tags(java.lang.Object tags)
An array of key-value pairs to apply to this resource.
|
CfnCampaign.Builder |
templateConfiguration(CfnCampaign.TemplateConfigurationProperty templateConfiguration)
The message template to use for the treatment.
|
CfnCampaign.Builder |
templateConfiguration(IResolvable templateConfiguration)
The message template to use for the treatment.
|
CfnCampaign.Builder |
treatmentDescription(java.lang.String treatmentDescription)
A custom description of the default treatment for the campaign.
|
CfnCampaign.Builder |
treatmentName(java.lang.String treatmentName)
A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
|
public static CfnCampaign.Builder create(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.CfnCampaign.AttributeDimensionProperty.Builder
.public CfnCampaign.Builder applicationId(java.lang.String applicationId)
applicationId
- The unique identifier for the Amazon Pinpoint application that the campaign is associated with. This parameter is required.this
public CfnCampaign.Builder name(java.lang.String name)
name
- The name of the campaign. This parameter is required.this
public CfnCampaign.Builder schedule(IResolvable schedule)
schedule
- The schedule settings for the campaign. This parameter is required.this
public CfnCampaign.Builder schedule(CfnCampaign.ScheduleProperty schedule)
schedule
- The schedule settings for the campaign. This parameter is required.this
public CfnCampaign.Builder segmentId(java.lang.String segmentId)
segmentId
- The unique identifier for the segment to associate with the campaign. This parameter is required.this
public CfnCampaign.Builder additionalTreatments(IResolvable additionalTreatments)
additionalTreatments
- An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. This parameter is required.this
public CfnCampaign.Builder additionalTreatments(java.util.List<? extends java.lang.Object> additionalTreatments)
additionalTreatments
- An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. This parameter is required.this
public CfnCampaign.Builder campaignHook(IResolvable campaignHook)
campaignHook
- Specifies the Lambda function to use as a code hook for a campaign. This parameter is required.this
public CfnCampaign.Builder campaignHook(CfnCampaign.CampaignHookProperty campaignHook)
campaignHook
- Specifies the Lambda function to use as a code hook for a campaign. This parameter is required.this
public CfnCampaign.Builder customDeliveryConfiguration(IResolvable customDeliveryConfiguration)
This object is required if the MessageConfiguration
object for the treatment specifies a CustomMessage
object.
customDeliveryConfiguration
- The delivery configuration settings for sending the treatment through a custom channel. This parameter is required.this
public CfnCampaign.Builder customDeliveryConfiguration(CfnCampaign.CustomDeliveryConfigurationProperty customDeliveryConfiguration)
This object is required if the MessageConfiguration
object for the treatment specifies a CustomMessage
object.
customDeliveryConfiguration
- The delivery configuration settings for sending the treatment through a custom channel. This parameter is required.this
public CfnCampaign.Builder description(java.lang.String description)
description
- A custom description of the campaign. This parameter is required.this
public CfnCampaign.Builder holdoutPercent(java.lang.Number holdoutPercent)
holdoutPercent
- The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. This parameter is required.this
public CfnCampaign.Builder isPaused(java.lang.Boolean isPaused)
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.
isPaused
- Specifies whether to pause the campaign. This parameter is required.this
public CfnCampaign.Builder isPaused(IResolvable isPaused)
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.
isPaused
- Specifies whether to pause the campaign. This parameter is required.this
public CfnCampaign.Builder limits(IResolvable limits)
limits
- The messaging limits for the campaign. This parameter is required.this
public CfnCampaign.Builder limits(CfnCampaign.LimitsProperty limits)
limits
- The messaging limits for the campaign. This parameter is required.this
public CfnCampaign.Builder messageConfiguration(IResolvable messageConfiguration)
messageConfiguration
- The message configuration settings for the campaign. This parameter is required.this
public CfnCampaign.Builder messageConfiguration(CfnCampaign.MessageConfigurationProperty messageConfiguration)
messageConfiguration
- The message configuration settings for the campaign. This parameter is required.this
public CfnCampaign.Builder priority(java.lang.Number priority)
If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.
priority
- 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. This parameter is required.this
public CfnCampaign.Builder segmentVersion(java.lang.Number segmentVersion)
segmentVersion
- The version of the segment to associate with the campaign. This parameter is required.this
public CfnCampaign.Builder tags(java.lang.Object tags)
For more information, see Tag .
tags
- An array of key-value pairs to apply to this resource. This parameter is required.this
public CfnCampaign.Builder templateConfiguration(IResolvable templateConfiguration)
templateConfiguration
- The message template to use for the treatment. This parameter is required.this
public CfnCampaign.Builder templateConfiguration(CfnCampaign.TemplateConfigurationProperty templateConfiguration)
templateConfiguration
- The message template to use for the treatment. This parameter is required.this
public CfnCampaign.Builder treatmentDescription(java.lang.String treatmentDescription)
treatmentDescription
- A custom description of the default treatment for the campaign. This parameter is required.this
public CfnCampaign.Builder treatmentName(java.lang.String treatmentName)
A treatment is a variation of a campaign that's used for A/B testing.
treatmentName
- A custom name of the default treatment for the campaign, if the campaign has multiple treatments. This parameter is required.this
public CfnCampaign build()