Struct aws_sdk_pinpoint::model::write_campaign_request::Builder

source · [−]

#[non_exhaustive]
pub struct Builder { /* private fields */ }

Expand description

A builder for WriteCampaignRequest

Implementations

source

impl Builder

source

pub fn additional_treatments(self, input: WriteTreatmentResource) -> Self

Appends an item to additional_treatments.

To override the contents of this collection use set_additional_treatments.

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

source

pub fn set_additional_treatments(
self,
input: Option<Vec<WriteTreatmentResource>>
) -> Self

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

source

pub fn custom_delivery_configuration(
self,
input: CustomDeliveryConfiguration
) -> Self

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.

source

pub fn set_custom_delivery_configuration(
self,
input: Option<CustomDeliveryConfiguration>
) -> Self

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.

source

pub fn description(self, input: impl Into<String>) -> Self

A custom description of the campaign.

source

pub fn set_description(self, input: Option<String>) -> Self

A custom description of the campaign.

source

pub fn holdout_percent(self, input: i32) -> Self

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

source

pub fn set_holdout_percent(self, input: Option<i32>) -> Self

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

source

pub fn hook(self, input: CampaignHook) -> Self

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.

source

pub fn set_hook(self, input: Option<CampaignHook>) -> Self

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.

source

pub fn is_paused(self, input: bool) -> Self

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

source

pub fn set_is_paused(self, input: Option<bool>) -> Self

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

source

pub fn limits(self, input: CampaignLimits) -> Self

The messaging limits for the campaign.

source

pub fn set_limits(self, input: Option<CampaignLimits>) -> Self

The messaging limits for the campaign.

source

pub fn message_configuration(self, input: MessageConfiguration) -> Self

The message configuration settings for the campaign.

source

pub fn set_message_configuration(
self,
input: Option<MessageConfiguration>
) -> Self

The message configuration settings for the campaign.

source

pub fn name(self, input: impl Into<String>) -> Self

A custom name for the campaign.

source

pub fn set_name(self, input: Option<String>) -> Self

A custom name for the campaign.

source

pub fn schedule(self, input: Schedule) -> Self

The schedule settings for the campaign.

source

pub fn set_schedule(self, input: Option<Schedule>) -> Self

The schedule settings for the campaign.

source

pub fn segment_id(self, input: impl Into<String>) -> Self

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

source

pub fn set_segment_id(self, input: Option<String>) -> Self

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

source

pub fn segment_version(self, input: i32) -> Self

The version of the segment to associate with the campaign.

source

pub fn set_segment_version(self, input: Option<i32>) -> Self

The version of the segment to associate with the campaign.

source

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

source

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

source

pub fn template_configuration(self, input: TemplateConfiguration) -> Self

The message template to use for the campaign.

source

pub fn set_template_configuration(
self,
input: Option<TemplateConfiguration>
) -> Self

The message template to use for the campaign.

source

pub fn treatment_description(self, input: impl Into<String>) -> Self

A custom description of the default treatment for the campaign.

source

pub fn set_treatment_description(self, input: Option<String>) -> Self

A custom description of the default treatment for the campaign.

source

pub fn treatment_name(self, input: impl Into<String>) -> Self

A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

source

pub fn set_treatment_name(self, input: Option<String>) -> Self

A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.

source

pub fn priority(self, input: i32) -> Self

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.

source

pub fn set_priority(self, input: Option<i32>) -> Self

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.

source