AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Pinpoint::Campaign

CfnCampaign

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

Import

import { CfnCampaign } from 'aws-cdk-lib/aws-pinpoint';

Or use the module namespace:

import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnCampaign

Properties

Configuration passed to the constructor as CfnCampaignProps.

applicationIdRequired
string

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

nameRequired
string

The name of the campaign.

scheduleRequired
IResolvable | ScheduleProperty

The schedule settings for the treatment.

segmentIdRequired
string

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

additionalTreatmentsOptional
IResolvable | IResolvable | WriteTreatmentResourceProperty[]

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

campaignHookOptional
IResolvable | CampaignHookProperty

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

customDeliveryConfigurationOptional
IResolvable | CustomDeliveryConfigurationProperty

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.

descriptionOptional
string

A custom description of the campaign.

holdoutPercentOptional
number

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

isPausedOptional
boolean | IResolvable

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.

limitsOptional
IResolvable | LimitsProperty

The messaging limits for the campaign.

messageConfigurationOptional
IResolvable | MessageConfigurationProperty

The message configuration settings for the treatment.

priorityOptional
number

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.

segmentVersionOptional
number

The version of the segment to associate with the campaign.

tagsOptional
any

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

templateConfigurationOptional
IResolvable | TemplateConfigurationProperty

The message template to use for the treatment.

treatmentDescriptionOptional
string

A custom description of the treatment.

treatmentNameOptional
string

A custom name for the treatment.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter