pinpoint/aws.sdk.kotlin.services.pinpoint.model/WriteCampaignRequest/Builder

Builder

Properties

var additionalTreatments: List<WriteTreatmentResource>?

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

customDeliveryConfiguration

var customDeliveryConfiguration: CustomDeliveryConfiguration?

The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.

description

var description: String?

A custom description of the campaign.

holdoutPercent

var holdoutPercent: Int?

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

hook

var hook: CampaignHook?

The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.

isPaused

var isPaused: Boolean?

Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.

limits

var limits: CampaignLimits?

The messaging limits for the campaign.

messageConfiguration

var messageConfiguration: MessageConfiguration?

The message configuration settings for the campaign.

name

var name: String?

A custom name for the campaign.

priority

var priority: Int?

Defines the priority of the campaign, used to decide the order of messages displayed to user if there are multiple messages scheduled to be displayed at the same moment.

schedule

var schedule: Schedule?

The schedule settings for the campaign.

segmentId

var segmentId: String?

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

segmentVersion

var segmentVersion: Int?

The version of the segment to associate with the campaign.