Package software.amazon.awscdk.services.pinpoint

Class CfnCampaignProps.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnCampaignProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCampaignProps>

Enclosing interface:

CfnCampaignProps

@Stability(Stable)
public static final class CfnCampaignProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCampaignProps>

A builder for CfnCampaignProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnCampaignProps.Builder	additionalTreatments(List<? extends Object> additionalTreatments)	Sets the value of CfnCampaignProps.getAdditionalTreatments()
CfnCampaignProps.Builder	additionalTreatments(IResolvable additionalTreatments)	Sets the value of CfnCampaignProps.getAdditionalTreatments()
CfnCampaignProps.Builder	applicationId(String applicationId)	Sets the value of CfnCampaignProps.getApplicationId()
CfnCampaignProps	build()	Builds the configured instance.
CfnCampaignProps.Builder	campaignHook(IResolvable campaignHook)	Sets the value of CfnCampaignProps.getCampaignHook()
CfnCampaignProps.Builder	campaignHook(CfnCampaign.CampaignHookProperty campaignHook)	Sets the value of CfnCampaignProps.getCampaignHook()
CfnCampaignProps.Builder	customDeliveryConfiguration(IResolvable customDeliveryConfiguration)	Sets the value of CfnCampaignProps.getCustomDeliveryConfiguration()
CfnCampaignProps.Builder	customDeliveryConfiguration(CfnCampaign.CustomDeliveryConfigurationProperty customDeliveryConfiguration)	Sets the value of CfnCampaignProps.getCustomDeliveryConfiguration()
CfnCampaignProps.Builder	description(String description)	Sets the value of CfnCampaignProps.getDescription()
CfnCampaignProps.Builder	holdoutPercent(Number holdoutPercent)	Sets the value of CfnCampaignProps.getHoldoutPercent()
CfnCampaignProps.Builder	isPaused(Boolean isPaused)	Sets the value of CfnCampaignProps.getIsPaused()
CfnCampaignProps.Builder	isPaused(IResolvable isPaused)	Sets the value of CfnCampaignProps.getIsPaused()
CfnCampaignProps.Builder	limits(IResolvable limits)	Sets the value of CfnCampaignProps.getLimits()
CfnCampaignProps.Builder	limits(CfnCampaign.LimitsProperty limits)	Sets the value of CfnCampaignProps.getLimits()
CfnCampaignProps.Builder	messageConfiguration(IResolvable messageConfiguration)	Sets the value of CfnCampaignProps.getMessageConfiguration()
CfnCampaignProps.Builder	messageConfiguration(CfnCampaign.MessageConfigurationProperty messageConfiguration)	Sets the value of CfnCampaignProps.getMessageConfiguration()
CfnCampaignProps.Builder	name(String name)	Sets the value of CfnCampaignProps.getName()
CfnCampaignProps.Builder	priority(Number priority)	Sets the value of CfnCampaignProps.getPriority()
CfnCampaignProps.Builder	schedule(IResolvable schedule)	Sets the value of CfnCampaignProps.getSchedule()
CfnCampaignProps.Builder	schedule(CfnCampaign.ScheduleProperty schedule)	Sets the value of CfnCampaignProps.getSchedule()
CfnCampaignProps.Builder	segmentId(String segmentId)	Sets the value of CfnCampaignProps.getSegmentId()
CfnCampaignProps.Builder	segmentVersion(Number segmentVersion)	Sets the value of CfnCampaignProps.getSegmentVersion()
CfnCampaignProps.Builder	tags(Object tags)	Sets the value of CfnCampaignProps.getTags()
CfnCampaignProps.Builder	templateConfiguration(IResolvable templateConfiguration)	Sets the value of CfnCampaignProps.getTemplateConfiguration()
CfnCampaignProps.Builder	templateConfiguration(CfnCampaign.TemplateConfigurationProperty templateConfiguration)	Sets the value of CfnCampaignProps.getTemplateConfiguration()
CfnCampaignProps.Builder	treatmentDescription(String treatmentDescription)	Sets the value of CfnCampaignProps.getTreatmentDescription()
CfnCampaignProps.Builder	treatmentName(String treatmentName)	Sets the value of CfnCampaignProps.getTreatmentName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

applicationId

@Stability(Stable)
public CfnCampaignProps.Builder applicationId(String applicationId)

Sets the value of CfnCampaignProps.getApplicationId()

Parameters:

applicationId - The unique identifier for the Amazon Pinpoint application that the campaign is associated with. This parameter is required.

Returns:

this

name

@Stability(Stable)
public CfnCampaignProps.Builder name(String name)

Sets the value of CfnCampaignProps.getName()

Parameters:

name - The name of the campaign. This parameter is required.

Returns:

this

schedule

@Stability(Stable)
public CfnCampaignProps.Builder schedule(IResolvable schedule)

Sets the value of CfnCampaignProps.getSchedule()

Parameters:

schedule - The schedule settings for the treatment. This parameter is required.

Returns:

this

schedule

@Stability(Stable)
public CfnCampaignProps.Builder schedule(CfnCampaign.ScheduleProperty schedule)

Sets the value of CfnCampaignProps.getSchedule()

Parameters:

schedule - The schedule settings for the treatment. This parameter is required.

Returns:

this

segmentId

@Stability(Stable)
public CfnCampaignProps.Builder segmentId(String segmentId)

Sets the value of CfnCampaignProps.getSegmentId()

Parameters:

segmentId - The unique identifier for the segment to associate with the campaign. This parameter is required.

Returns:

this

additionalTreatments

@Stability(Stable)
public CfnCampaignProps.Builder additionalTreatments(IResolvable additionalTreatments)

Sets the value of CfnCampaignProps.getAdditionalTreatments()

Parameters:

additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

Returns:

this

additionalTreatments

@Stability(Stable)
public CfnCampaignProps.Builder additionalTreatments(List<? extends Object> additionalTreatments)

Sets the value of CfnCampaignProps.getAdditionalTreatments()

Parameters:

additionalTreatments - An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

Returns:

this

campaignHook

@Stability(Stable)
public CfnCampaignProps.Builder campaignHook(IResolvable campaignHook)

Sets the value of CfnCampaignProps.getCampaignHook()

Parameters:

campaignHook - Specifies the Lambda function to use as a code hook for a campaign.

Returns:

this

campaignHook

@Stability(Stable)
public CfnCampaignProps.Builder campaignHook(CfnCampaign.CampaignHookProperty campaignHook)

Sets the value of CfnCampaignProps.getCampaignHook()

Parameters:

campaignHook - Specifies the Lambda function to use as a code hook for a campaign.

Returns:

this

customDeliveryConfiguration

@Stability(Stable)
public CfnCampaignProps.Builder customDeliveryConfiguration(IResolvable customDeliveryConfiguration)

Sets the value of CfnCampaignProps.getCustomDeliveryConfiguration()

Parameters:

customDeliveryConfiguration - 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:

this

customDeliveryConfiguration

@Stability(Stable)
public CfnCampaignProps.Builder customDeliveryConfiguration(CfnCampaign.CustomDeliveryConfigurationProperty customDeliveryConfiguration)

Sets the value of CfnCampaignProps.getCustomDeliveryConfiguration()

Parameters:

customDeliveryConfiguration - 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:

this

description

@Stability(Stable)
public CfnCampaignProps.Builder description(String description)

Sets the value of CfnCampaignProps.getDescription()

Parameters:

description - A custom description of the campaign.

Returns:

this

holdoutPercent

@Stability(Stable)
public CfnCampaignProps.Builder holdoutPercent(Number holdoutPercent)

Sets the value of CfnCampaignProps.getHoldoutPercent()

Parameters:

holdoutPercent - The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

Returns:

this

isPaused

@Stability(Stable)
public CfnCampaignProps.Builder isPaused(Boolean isPaused)

Sets the value of CfnCampaignProps.getIsPaused()

Parameters:

isPaused - Specifies whether to pause the campaign. 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. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.

Returns:

this

isPaused

@Stability(Stable)
public CfnCampaignProps.Builder isPaused(IResolvable isPaused)

Sets the value of CfnCampaignProps.getIsPaused()

Parameters:

isPaused - Specifies whether to pause the campaign. 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. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused.

Returns:

this

limits

@Stability(Stable)
public CfnCampaignProps.Builder limits(IResolvable limits)

Sets the value of CfnCampaignProps.getLimits()

Parameters:

limits - The messaging limits for the campaign.

Returns:

this

limits

@Stability(Stable)
public CfnCampaignProps.Builder limits(CfnCampaign.LimitsProperty limits)

Sets the value of CfnCampaignProps.getLimits()

Parameters:

limits - The messaging limits for the campaign.

Returns:

this

messageConfiguration

@Stability(Stable)
public CfnCampaignProps.Builder messageConfiguration(IResolvable messageConfiguration)

Sets the value of CfnCampaignProps.getMessageConfiguration()

Parameters:

messageConfiguration - The message configuration settings for the treatment.

Returns:

this

messageConfiguration

@Stability(Stable)
public CfnCampaignProps.Builder messageConfiguration(CfnCampaign.MessageConfigurationProperty messageConfiguration)

Sets the value of CfnCampaignProps.getMessageConfiguration()

Parameters:

messageConfiguration - The message configuration settings for the treatment.

Returns:

this

priority

@Stability(Stable)
public CfnCampaignProps.Builder priority(Number priority)

Sets the value of CfnCampaignProps.getPriority()

Parameters:

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. If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.

Returns:

this

segmentVersion

@Stability(Stable)
public CfnCampaignProps.Builder segmentVersion(Number segmentVersion)

Sets the value of CfnCampaignProps.getSegmentVersion()

Parameters:

segmentVersion - The version of the segment to associate with the campaign.

Returns:

this

tags

@Stability(Stable)
public CfnCampaignProps.Builder tags(Object tags)

Sets the value of CfnCampaignProps.getTags()

Parameters:

tags - An array of key-value pairs to apply to this resource. For more information, see Tag .

Returns:

this

templateConfiguration

@Stability(Stable)
public CfnCampaignProps.Builder templateConfiguration(IResolvable templateConfiguration)

Sets the value of CfnCampaignProps.getTemplateConfiguration()

Parameters:

templateConfiguration - The message template to use for the treatment.

Returns:

this

templateConfiguration

@Stability(Stable)
public CfnCampaignProps.Builder templateConfiguration(CfnCampaign.TemplateConfigurationProperty templateConfiguration)

Sets the value of CfnCampaignProps.getTemplateConfiguration()

Parameters:

templateConfiguration - The message template to use for the treatment.

Returns:

this

treatmentDescription

@Stability(Stable)
public CfnCampaignProps.Builder treatmentDescription(String treatmentDescription)

Sets the value of CfnCampaignProps.getTreatmentDescription()

Parameters:

treatmentDescription - A custom description of the treatment.

Returns:

this

treatmentName

@Stability(Stable)
public CfnCampaignProps.Builder treatmentName(String treatmentName)

Sets the value of CfnCampaignProps.getTreatmentName()

Parameters:

treatmentName - A custom name for the treatment.

Returns:

this

build

@Stability(Stable)
public CfnCampaignProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCampaignProps>

Returns:

a new instance of CfnCampaignProps

Throws:

NullPointerException - if any required attribute was not provided