AWS::Pinpoint::Campaign

Specifies the settings for a campaign. A campaign is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application.

Syntax

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

JSON

{
  "Type" : "AWS::Pinpoint::Campaign",
  "Properties" : {
      "AdditionalTreatments" : [ WriteTreatmentResource, ... ],
      "ApplicationId" : String,
      "CampaignHook" : CampaignHook,
      "CustomDeliveryConfiguration" : CustomDeliveryConfiguration,
      "Description" : String,
      "HoldoutPercent" : Integer,
      "IsPaused" : Boolean,
      "Limits" : Limits,
      "MessageConfiguration" : MessageConfiguration,
      "Name" : String,
      "Priority" : Integer,
      "Schedule" : Schedule,
      "SegmentId" : String,
      "SegmentVersion" : Integer,
      "Tags" : [ Tag, ... ],
      "TemplateConfiguration" : TemplateConfiguration,
      "TreatmentDescription" : String,
      "TreatmentName" : String
    }
}

YAML

Type: AWS::Pinpoint::Campaign
Properties:
  AdditionalTreatments: 
    - WriteTreatmentResource
  ApplicationId: String
  CampaignHook: 
    CampaignHook
  CustomDeliveryConfiguration: 
    CustomDeliveryConfiguration
  Description: String
  HoldoutPercent: Integer
  IsPaused: Boolean
  Limits: 
    Limits
  MessageConfiguration: 
    MessageConfiguration
  Name: String
  Priority: Integer
  Schedule: 
    Schedule
  SegmentId: String
  SegmentVersion: Integer
  Tags: 
    - Tag
  TemplateConfiguration: 
    TemplateConfiguration
  TreatmentDescription: String
  TreatmentName: String

Properties

AdditionalTreatments

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

Required: No

Type: Array of WriteTreatmentResource

Update requires: No interruption

ApplicationId

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

Required: Yes

Type: String

Update requires: Replacement

CampaignHook

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

Required: No

Type: CampaignHook

Update requires: No interruption

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

Description

A custom description of the campaign.

Required: No

Type: String

Update requires: No interruption

HoldoutPercent

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

Required: No

Type: Integer

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

Limits

The messaging limits for the campaign.

Required: No

Type: Limits

Update requires: No interruption

MessageConfiguration

The message configuration settings for the treatment.

Required: No

Type: MessageConfiguration

Update requires: No interruption

Name

The name of the campaign.

Required: Yes

Type: String

Update requires: No interruption

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.

Required: No

Type: Integer

Update requires: No interruption

Schedule

The schedule settings for the treatment.

Required: Yes

Type: Schedule

Update requires: No interruption

SegmentId

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

Required: Yes

Type: String

Update requires: No interruption

SegmentVersion

The version of the segment to associate with the campaign.

Required: No

Type: Integer

Update requires: No interruption

Tags

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

For more information, see Tag.

Required: No

Type: Array of Tag

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

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a string that combines the unique identifier for the Amazon Pinpoint application with the unique identifier for the segment that the campaign targets.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the campaign.

CampaignId

The unique identifier for the campaign.