Interface ICfnCampaignProps
Properties for defining a CfnCampaign.
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnCampaignPropsSyntax (vb)
Public Interface ICfnCampaignPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;
var attributes;
var customConfig;
var metrics;
var tags;
var cfnCampaignProps = new CfnCampaignProps {
ApplicationId = "applicationId",
Name = "name",
Schedule = new ScheduleProperty {
EndTime = "endTime",
EventFilter = new CampaignEventFilterProperty {
Dimensions = new EventDimensionsProperty {
Attributes = attributes,
EventType = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Metrics = metrics
},
FilterType = "filterType"
},
Frequency = "frequency",
IsLocalTime = false,
QuietTime = new QuietTimeProperty {
End = "end",
Start = "start"
},
StartTime = "startTime",
TimeZone = "timeZone"
},
SegmentId = "segmentId",
// the properties below are optional
AdditionalTreatments = new [] { new WriteTreatmentResourceProperty {
CustomDeliveryConfiguration = new CustomDeliveryConfigurationProperty {
DeliveryUri = "deliveryUri",
EndpointTypes = new [] { "endpointTypes" }
},
MessageConfiguration = new MessageConfigurationProperty {
AdmMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
ApnsMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
BaiduMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
CustomMessage = new CampaignCustomMessageProperty {
Data = "data"
},
DefaultMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
EmailMessage = new CampaignEmailMessageProperty {
Body = "body",
FromAddress = "fromAddress",
HtmlBody = "htmlBody",
Title = "title"
},
GcmMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
InAppMessage = new CampaignInAppMessageProperty {
Content = new [] { new InAppMessageContentProperty {
BackgroundColor = "backgroundColor",
BodyConfig = new InAppMessageBodyConfigProperty {
Alignment = "alignment",
Body = "body",
TextColor = "textColor"
},
HeaderConfig = new InAppMessageHeaderConfigProperty {
Alignment = "alignment",
Header = "header",
TextColor = "textColor"
},
ImageUrl = "imageUrl",
PrimaryBtn = new InAppMessageButtonProperty {
Android = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
DefaultConfig = new DefaultButtonConfigurationProperty {
BackgroundColor = "backgroundColor",
BorderRadius = 123,
ButtonAction = "buttonAction",
Link = "link",
Text = "text",
TextColor = "textColor"
},
Ios = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
Web = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
}
},
SecondaryBtn = new InAppMessageButtonProperty {
Android = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
DefaultConfig = new DefaultButtonConfigurationProperty {
BackgroundColor = "backgroundColor",
BorderRadius = 123,
ButtonAction = "buttonAction",
Link = "link",
Text = "text",
TextColor = "textColor"
},
Ios = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
Web = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
}
}
} },
CustomConfig = customConfig,
Layout = "layout"
},
SmsMessage = new CampaignSmsMessageProperty {
Body = "body",
EntityId = "entityId",
MessageType = "messageType",
OriginationNumber = "originationNumber",
SenderId = "senderId",
TemplateId = "templateId"
}
},
Schedule = new ScheduleProperty {
EndTime = "endTime",
EventFilter = new CampaignEventFilterProperty {
Dimensions = new EventDimensionsProperty {
Attributes = attributes,
EventType = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Metrics = metrics
},
FilterType = "filterType"
},
Frequency = "frequency",
IsLocalTime = false,
QuietTime = new QuietTimeProperty {
End = "end",
Start = "start"
},
StartTime = "startTime",
TimeZone = "timeZone"
},
SizePercent = 123,
TemplateConfiguration = new TemplateConfigurationProperty {
EmailTemplate = new TemplateProperty {
Name = "name",
Version = "version"
},
PushTemplate = new TemplateProperty {
Name = "name",
Version = "version"
},
SmsTemplate = new TemplateProperty {
Name = "name",
Version = "version"
},
VoiceTemplate = new TemplateProperty {
Name = "name",
Version = "version"
}
},
TreatmentDescription = "treatmentDescription",
TreatmentName = "treatmentName"
} },
CampaignHook = new CampaignHookProperty {
LambdaFunctionName = "lambdaFunctionName",
Mode = "mode",
WebUrl = "webUrl"
},
CustomDeliveryConfiguration = new CustomDeliveryConfigurationProperty {
DeliveryUri = "deliveryUri",
EndpointTypes = new [] { "endpointTypes" }
},
Description = "description",
HoldoutPercent = 123,
IsPaused = false,
Limits = new LimitsProperty {
Daily = 123,
MaximumDuration = 123,
MessagesPerSecond = 123,
Session = 123,
Total = 123
},
MessageConfiguration = new MessageConfigurationProperty {
AdmMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
ApnsMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
BaiduMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
CustomMessage = new CampaignCustomMessageProperty {
Data = "data"
},
DefaultMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
EmailMessage = new CampaignEmailMessageProperty {
Body = "body",
FromAddress = "fromAddress",
HtmlBody = "htmlBody",
Title = "title"
},
GcmMessage = new MessageProperty {
Action = "action",
Body = "body",
ImageIconUrl = "imageIconUrl",
ImageSmallIconUrl = "imageSmallIconUrl",
ImageUrl = "imageUrl",
JsonBody = "jsonBody",
MediaUrl = "mediaUrl",
RawContent = "rawContent",
SilentPush = false,
TimeToLive = 123,
Title = "title",
Url = "url"
},
InAppMessage = new CampaignInAppMessageProperty {
Content = new [] { new InAppMessageContentProperty {
BackgroundColor = "backgroundColor",
BodyConfig = new InAppMessageBodyConfigProperty {
Alignment = "alignment",
Body = "body",
TextColor = "textColor"
},
HeaderConfig = new InAppMessageHeaderConfigProperty {
Alignment = "alignment",
Header = "header",
TextColor = "textColor"
},
ImageUrl = "imageUrl",
PrimaryBtn = new InAppMessageButtonProperty {
Android = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
DefaultConfig = new DefaultButtonConfigurationProperty {
BackgroundColor = "backgroundColor",
BorderRadius = 123,
ButtonAction = "buttonAction",
Link = "link",
Text = "text",
TextColor = "textColor"
},
Ios = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
Web = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
}
},
SecondaryBtn = new InAppMessageButtonProperty {
Android = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
DefaultConfig = new DefaultButtonConfigurationProperty {
BackgroundColor = "backgroundColor",
BorderRadius = 123,
ButtonAction = "buttonAction",
Link = "link",
Text = "text",
TextColor = "textColor"
},
Ios = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
},
Web = new OverrideButtonConfigurationProperty {
ButtonAction = "buttonAction",
Link = "link"
}
}
} },
CustomConfig = customConfig,
Layout = "layout"
},
SmsMessage = new CampaignSmsMessageProperty {
Body = "body",
EntityId = "entityId",
MessageType = "messageType",
OriginationNumber = "originationNumber",
SenderId = "senderId",
TemplateId = "templateId"
}
},
Priority = 123,
SegmentVersion = 123,
Tags = tags,
TemplateConfiguration = new TemplateConfigurationProperty {
EmailTemplate = new TemplateProperty {
Name = "name",
Version = "version"
},
PushTemplate = new TemplateProperty {
Name = "name",
Version = "version"
},
SmsTemplate = new TemplateProperty {
Name = "name",
Version = "version"
},
VoiceTemplate = new TemplateProperty {
Name = "name",
Version = "version"
}
},
TreatmentDescription = "treatmentDescription",
TreatmentName = "treatmentName"
};Synopsis
Properties
| AdditionalTreatments | An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. |
| ApplicationId | The unique identifier for the Amazon Pinpoint application that the campaign is associated with. |
| CampaignHook | Specifies the Lambda function to use as a code hook for a campaign. |
| CustomDeliveryConfiguration | The delivery configuration settings for sending the treatment through a custom channel. |
| Description | A custom description of the campaign. |
| HoldoutPercent | The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. |
| IsPaused | Specifies whether to pause the campaign. |
| Limits | The messaging limits for the campaign. |
| MessageConfiguration | The message configuration settings for the treatment. |
| Name | The name of the campaign. |
| 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. |
| Schedule | The schedule settings for the treatment. |
| SegmentId | The unique identifier for the segment to associate with the campaign. |
| SegmentVersion | The version of the segment to associate with the campaign. |
| Tags | An array of key-value pairs to apply to this resource. |
| TemplateConfiguration | The message template to use for the treatment. |
| TreatmentDescription | A custom description of the treatment. |
| TreatmentName | A custom name for the treatment. |
Properties
AdditionalTreatments
An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
object? AdditionalTreatments { get; }Property Value
Remarks
ApplicationId
The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
string ApplicationId { get; }Property Value
Remarks
CampaignHook
Specifies the Lambda function to use as a code hook for a campaign.
object? CampaignHook { get; }Property Value
Remarks
CustomDeliveryConfiguration
The delivery configuration settings for sending the treatment through a custom channel.
object? CustomDeliveryConfiguration { get; }Property Value
Remarks
This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
Type union: either IResolvable or CfnCampaign.ICustomDeliveryConfigurationProperty
Description
A custom description of the campaign.
string? Description { get; }Property Value
Remarks
HoldoutPercent
The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
double? HoldoutPercent { get; }Property Value
Remarks
IsPaused
Specifies whether to pause the campaign.
object? IsPaused { get; }Property Value
Remarks
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.
Type union: either bool or IResolvable
Limits
The messaging limits for the campaign.
object? Limits { get; }Property Value
Remarks
MessageConfiguration
The message configuration settings for the treatment.
object? MessageConfiguration { get; }Property Value
Remarks
Name
The name of the campaign.
string Name { get; }Property Value
Remarks
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.
double? Priority { get; }Property Value
Remarks
If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.
Schedule
The schedule settings for the treatment.
object Schedule { get; }Property Value
Remarks
SegmentId
The unique identifier for the segment to associate with the campaign.
string SegmentId { get; }Property Value
Remarks
SegmentVersion
The version of the segment to associate with the campaign.
double? SegmentVersion { get; }Property Value
Remarks
Tags
An array of key-value pairs to apply to this resource.
object? Tags { get; }Property Value
Remarks
For more information, see Tag .
TemplateConfiguration
The message template to use for the treatment.
object? TemplateConfiguration { get; }Property Value
Remarks
TreatmentDescription
A custom description of the treatment.
string? TreatmentDescription { get; }Property Value
Remarks
TreatmentName
A custom name for the treatment.
string? TreatmentName { get; }