Package software.amazon.awscdk.services.pinpoint

Class CfnCampaign.Builder

java.lang.Object

software.amazon.awscdk.services.pinpoint.CfnCampaign.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCampaign>

Enclosing class:

CfnCampaign

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

A fluent builder for CfnCampaign.

Method Summary

Modifier and Type	Method	Description
CfnCampaign.Builder	additionalTreatments(List<? extends Object> additionalTreatments)	An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
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	applicationId(String applicationId)	The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
CfnCampaign	build()
CfnCampaign.Builder	campaignHook(IResolvable campaignHook)	Specifies the Lambda function to use as a code hook for a campaign.
CfnCampaign.Builder	campaignHook(CfnCampaign.CampaignHookProperty campaignHook)	Specifies the Lambda function to use as a code hook for a campaign.
static CfnCampaign.Builder	create(software.constructs.Construct scope, String id)
CfnCampaign.Builder	customDeliveryConfiguration(IResolvable customDeliveryConfiguration)	The delivery configuration settings for sending the treatment through a custom channel.
CfnCampaign.Builder	customDeliveryConfiguration(CfnCampaign.CustomDeliveryConfigurationProperty customDeliveryConfiguration)	The delivery configuration settings for sending the treatment through a custom channel.
CfnCampaign.Builder	description(String description)	A custom description of the campaign.
CfnCampaign.Builder	holdoutPercent(Number holdoutPercent)	The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
CfnCampaign.Builder	isPaused(Boolean isPaused)	Specifies whether to pause the campaign.
CfnCampaign.Builder	isPaused(IResolvable isPaused)	Specifies whether to pause the campaign.
CfnCampaign.Builder	limits(IResolvable limits)	The messaging limits for the campaign.
CfnCampaign.Builder	limits(CfnCampaign.LimitsProperty limits)	The messaging limits for the campaign.
CfnCampaign.Builder	messageConfiguration(IResolvable messageConfiguration)	The message configuration settings for the treatment.
CfnCampaign.Builder	messageConfiguration(CfnCampaign.MessageConfigurationProperty messageConfiguration)	The message configuration settings for the treatment.
CfnCampaign.Builder	name(String name)	The name of the campaign.
CfnCampaign.Builder	priority(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(IResolvable schedule)	The schedule settings for the treatment.
CfnCampaign.Builder	schedule(CfnCampaign.ScheduleProperty schedule)	The schedule settings for the treatment.
CfnCampaign.Builder	segmentId(String segmentId)	The unique identifier for the segment to associate with the campaign.
CfnCampaign.Builder	segmentVersion(Number segmentVersion)	The version of the segment to associate with the campaign.
CfnCampaign.Builder	tags(Object tags)	An array of key-value pairs to apply to this resource.
CfnCampaign.Builder	templateConfiguration(IResolvable templateConfiguration)	The message template to use for the treatment.
CfnCampaign.Builder	templateConfiguration(CfnCampaign.TemplateConfigurationProperty templateConfiguration)	The message template to use for the treatment.
CfnCampaign.Builder	treatmentDescription(String treatmentDescription)	A custom description of the treatment.
CfnCampaign.Builder	treatmentName(String treatmentName)	A custom name for the treatment.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnCampaign.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCampaign.Builder.

applicationId

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-applicationid

name

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

The name of the campaign.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-name

schedule

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

The schedule settings for the treatment.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-schedule

schedule

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

The schedule settings for the treatment.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-schedule

segmentId

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentid

additionalTreatments

@Stability(Stable)
public 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.

Parameters:

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.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-additionaltreatments

additionalTreatments

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

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

Parameters:

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.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-additionaltreatments

campaignHook

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

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

Parameters:

campaignHook - Specifies the Lambda function to use as a code hook for a campaign. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-campaignhook

campaignHook

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

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

Parameters:

campaignHook - Specifies the Lambda function to use as a code hook for a campaign. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-campaignhook

customDeliveryConfiguration

@Stability(Stable)
public CfnCampaign.Builder customDeliveryConfiguration(IResolvable 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.

Parameters:

customDeliveryConfiguration - The delivery configuration settings for sending the treatment through a custom channel. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-customdeliveryconfiguration

customDeliveryConfiguration

@Stability(Stable)
public CfnCampaign.Builder customDeliveryConfiguration(CfnCampaign.CustomDeliveryConfigurationProperty 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.

Parameters:

customDeliveryConfiguration - The delivery configuration settings for sending the treatment through a custom channel. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-customdeliveryconfiguration

description

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

A custom description of the campaign.

Parameters:

description - A custom description of the campaign. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-description

holdoutPercent

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-holdoutpercent

isPaused

@Stability(Stable)
public CfnCampaign.Builder isPaused(Boolean 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.

Parameters:

isPaused - Specifies whether to pause the campaign. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-ispaused

isPaused

@Stability(Stable)
public CfnCampaign.Builder isPaused(IResolvable 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.

Parameters:

isPaused - Specifies whether to pause the campaign. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-ispaused

limits

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

The messaging limits for the campaign.

Parameters:

limits - The messaging limits for the campaign. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-limits

limits

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

The messaging limits for the campaign.

Parameters:

limits - The messaging limits for the campaign. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-limits

messageConfiguration

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

The message configuration settings for the treatment.

Parameters:

messageConfiguration - The message configuration settings for the treatment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-messageconfiguration

messageConfiguration

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

The message configuration settings for the treatment.

Parameters:

messageConfiguration - The message configuration settings for the treatment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-messageconfiguration

priority

@Stability(Stable)
public CfnCampaign.Builder priority(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.

If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-priority

segmentVersion

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

The version of the segment to associate with the campaign.

Parameters:

segmentVersion - The version of the segment to associate with the campaign. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentversion

tags

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

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-tags

templateConfiguration

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

The message template to use for the treatment.

Parameters:

templateConfiguration - The message template to use for the treatment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-templateconfiguration

templateConfiguration

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

The message template to use for the treatment.

Parameters:

templateConfiguration - The message template to use for the treatment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-templateconfiguration

treatmentDescription

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

A custom description of the treatment.

Parameters:

treatmentDescription - A custom description of the treatment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentdescription

treatmentName

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

A custom name for the treatment.

Parameters:

treatmentName - A custom name for the treatment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentname

build

@Stability(Stable)
public CfnCampaign build()

Specified by:

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

Returns:

a newly built instance of CfnCampaign.