AWS::Pinpoint::Campaign WriteTreatmentResource

Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "CustomDeliveryConfiguration" : CustomDeliveryConfiguration,
  "MessageConfiguration" : MessageConfiguration,
  "Schedule" : Schedule,
  "SizePercent" : Integer,
  "TemplateConfiguration" : TemplateConfiguration,
  "TreatmentDescription" : String,
  "TreatmentName" : String
}

YAML

  CustomDeliveryConfiguration: 
    CustomDeliveryConfiguration
  MessageConfiguration: 
    MessageConfiguration
  Schedule: 
    Schedule
  SizePercent: Integer
  TemplateConfiguration: 
    TemplateConfiguration
  TreatmentDescription: String
  TreatmentName: String

Properties

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.

Required: No

Type: CustomDeliveryConfiguration

Update requires: No interruption

MessageConfiguration

The message configuration settings for the treatment.

Required: No

Type: MessageConfiguration

Update requires: No interruption

Schedule

The schedule settings for the treatment.

Required: No

Type: Schedule

Update requires: No interruption

SizePercent

The allocated percentage of users (segment members) to send the treatment to.

Required: No

Type: Integer

Update requires: No interruption

TemplateConfiguration

The message template to use for the treatment.

Required: No

Type: TemplateConfiguration

Update requires: No interruption

TreatmentDescription

A custom description of the treatment.

Required: No

Type: String

Update requires: No interruption

TreatmentName

A custom name for the treatment.

Required: No

Type: String

Update requires: No interruption