Package software.amazon.awscdk.cfnpropertymixins.services.pinpoint

Class CfnCampaignMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.pinpoint.CfnCampaignMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCampaignMixinProps>

Enclosing interface:

CfnCampaignMixinProps

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

A builder for CfnCampaignMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

additionalTreatments

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

Sets the value of CfnCampaignMixinProps.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 CfnCampaignMixinProps.Builder additionalTreatments(List<? extends Object> additionalTreatments)

Sets the value of CfnCampaignMixinProps.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

applicationId

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

Sets the value of CfnCampaignMixinProps.getApplicationId()

Parameters:

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

Returns:

this

campaignHook

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

Sets the value of CfnCampaignMixinProps.getCampaignHook()

Parameters:

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

Returns:

this

campaignHook

@Stability(Stable)
public CfnCampaignMixinProps.Builder campaignHook(CfnCampaignPropsMixin.CampaignHookProperty campaignHook)

Sets the value of CfnCampaignMixinProps.getCampaignHook()

Parameters:

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

Returns:

this

customDeliveryConfiguration

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

Sets the value of CfnCampaignMixinProps.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 CfnCampaignMixinProps.Builder customDeliveryConfiguration(CfnCampaignPropsMixin.CustomDeliveryConfigurationProperty customDeliveryConfiguration)

Sets the value of CfnCampaignMixinProps.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 CfnCampaignMixinProps.Builder description(String description)

Sets the value of CfnCampaignMixinProps.getDescription()

Parameters:

description - A custom description of the campaign.

Returns:

this

holdoutPercent

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

Sets the value of CfnCampaignMixinProps.getHoldoutPercent()

Parameters:

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

Returns:

this

isPaused

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

Sets the value of CfnCampaignMixinProps.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 CfnCampaignMixinProps.Builder isPaused(IResolvable isPaused)

Sets the value of CfnCampaignMixinProps.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 CfnCampaignMixinProps.Builder limits(IResolvable limits)

Sets the value of CfnCampaignMixinProps.getLimits()

Parameters:

limits - The messaging limits for the campaign.

Returns:

this

limits

@Stability(Stable)
public CfnCampaignMixinProps.Builder limits(CfnCampaignPropsMixin.LimitsProperty limits)

Sets the value of CfnCampaignMixinProps.getLimits()

Parameters:

limits - The messaging limits for the campaign.

Returns:

this

messageConfiguration

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

Sets the value of CfnCampaignMixinProps.getMessageConfiguration()

Parameters:

messageConfiguration - The message configuration settings for the treatment.

Returns:

this

messageConfiguration

@Stability(Stable)
public CfnCampaignMixinProps.Builder messageConfiguration(CfnCampaignPropsMixin.MessageConfigurationProperty messageConfiguration)

Sets the value of CfnCampaignMixinProps.getMessageConfiguration()

Parameters:

messageConfiguration - The message configuration settings for the treatment.

Returns:

this

name

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

Sets the value of CfnCampaignMixinProps.getName()

Parameters:

name - The name of the campaign.

Returns:

this

priority

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

Sets the value of CfnCampaignMixinProps.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

schedule

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

Sets the value of CfnCampaignMixinProps.getSchedule()

Parameters:

schedule - The schedule settings for the treatment.

Returns:

this

schedule

@Stability(Stable)
public CfnCampaignMixinProps.Builder schedule(CfnCampaignPropsMixin.ScheduleProperty schedule)

Sets the value of CfnCampaignMixinProps.getSchedule()

Parameters:

schedule - The schedule settings for the treatment.

Returns:

this

segmentId

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

Sets the value of CfnCampaignMixinProps.getSegmentId()

Parameters:

segmentId - The unique identifier for the segment to associate with the campaign.

Returns:

this

segmentVersion

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

Sets the value of CfnCampaignMixinProps.getSegmentVersion()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnCampaignMixinProps.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 CfnCampaignMixinProps.Builder templateConfiguration(IResolvable templateConfiguration)

Sets the value of CfnCampaignMixinProps.getTemplateConfiguration()

Parameters:

templateConfiguration - The message template to use for the treatment.

Returns:

this

templateConfiguration

@Stability(Stable)
public CfnCampaignMixinProps.Builder templateConfiguration(CfnCampaignPropsMixin.TemplateConfigurationProperty templateConfiguration)

Sets the value of CfnCampaignMixinProps.getTemplateConfiguration()

Parameters:

templateConfiguration - The message template to use for the treatment.

Returns:

this

treatmentDescription

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

Sets the value of CfnCampaignMixinProps.getTreatmentDescription()

Parameters:

treatmentDescription - A custom description of the treatment.

Returns:

this

treatmentName

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

Sets the value of CfnCampaignMixinProps.getTreatmentName()

Parameters:

treatmentName - A custom name for the treatment.

Returns:

this

build

@Stability(Stable)
public CfnCampaignMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnCampaignMixinProps

Throws:

NullPointerException - if any required attribute was not provided