This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Pinpoint::Campaign WriteTreatmentResource
<a name="aws-properties-pinpoint-campaign-writetreatmentresource"></a>

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
<a name="aws-properties-pinpoint-campaign-writetreatmentresource-syntax"></a>

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

### JSON
<a name="aws-properties-pinpoint-campaign-writetreatmentresource-syntax.json"></a>

```
{
  "[CustomDeliveryConfiguration](#cfn-pinpoint-campaign-writetreatmentresource-customdeliveryconfiguration)" : CustomDeliveryConfiguration,
  "[MessageConfiguration](#cfn-pinpoint-campaign-writetreatmentresource-messageconfiguration)" : MessageConfiguration,
  "[Schedule](#cfn-pinpoint-campaign-writetreatmentresource-schedule)" : Schedule,
  "[SizePercent](#cfn-pinpoint-campaign-writetreatmentresource-sizepercent)" : Integer,
  "[TemplateConfiguration](#cfn-pinpoint-campaign-writetreatmentresource-templateconfiguration)" : TemplateConfiguration,
  "[TreatmentDescription](#cfn-pinpoint-campaign-writetreatmentresource-treatmentdescription)" : String,
  "[TreatmentName](#cfn-pinpoint-campaign-writetreatmentresource-treatmentname)" : String
}
```

### YAML
<a name="aws-properties-pinpoint-campaign-writetreatmentresource-syntax.yaml"></a>

```
  [CustomDeliveryConfiguration](#cfn-pinpoint-campaign-writetreatmentresource-customdeliveryconfiguration): 
    CustomDeliveryConfiguration
  [MessageConfiguration](#cfn-pinpoint-campaign-writetreatmentresource-messageconfiguration): 
    MessageConfiguration
  [Schedule](#cfn-pinpoint-campaign-writetreatmentresource-schedule): 
    Schedule
  [SizePercent](#cfn-pinpoint-campaign-writetreatmentresource-sizepercent): Integer
  [TemplateConfiguration](#cfn-pinpoint-campaign-writetreatmentresource-templateconfiguration): 
    TemplateConfiguration
  [TreatmentDescription](#cfn-pinpoint-campaign-writetreatmentresource-treatmentdescription): String
  [TreatmentName](#cfn-pinpoint-campaign-writetreatmentresource-treatmentname): String
```

## Properties
<a name="aws-properties-pinpoint-campaign-writetreatmentresource-properties"></a>

`CustomDeliveryConfiguration`  <a name="cfn-pinpoint-campaign-writetreatmentresource-customdeliveryconfiguration"></a>
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](aws-properties-pinpoint-campaign-customdeliveryconfiguration.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MessageConfiguration`  <a name="cfn-pinpoint-campaign-writetreatmentresource-messageconfiguration"></a>
The message configuration settings for the treatment.  
*Required*: No  
*Type*: [MessageConfiguration](aws-properties-pinpoint-campaign-messageconfiguration.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Schedule`  <a name="cfn-pinpoint-campaign-writetreatmentresource-schedule"></a>
The schedule settings for the treatment.  
*Required*: No  
*Type*: [Schedule](aws-properties-pinpoint-campaign-schedule.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SizePercent`  <a name="cfn-pinpoint-campaign-writetreatmentresource-sizepercent"></a>
The allocated percentage of users (segment members) to send the treatment to.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TemplateConfiguration`  <a name="cfn-pinpoint-campaign-writetreatmentresource-templateconfiguration"></a>
The message template to use for the treatment.  
*Required*: No  
*Type*: [TemplateConfiguration](aws-properties-pinpoint-campaign-templateconfiguration.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TreatmentDescription`  <a name="cfn-pinpoint-campaign-writetreatmentresource-treatmentdescription"></a>
A custom description of the treatment.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TreatmentName`  <a name="cfn-pinpoint-campaign-writetreatmentresource-treatmentname"></a>
A custom name for the treatment.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)