AWS::Pinpoint::Campaign - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::Pinpoint::Campaign

活动 是一种消息传送计划,可以吸引特定分段的用户使用 Amazon Pinpoint 应用程序。AWS::Pinpoint::Campaign 资源定义了市场活动的配置和其他设置。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

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

属性

AdditionalTreatments

除了为活动定义默认处理之外,还为活动定义其他处理的请求的数组。

必需:否

类型WriteTreatmentResource 的列表

Update requires: No interruption

ApplicationId

与活动关联的 Amazon Pinpoint 应用程序的唯一标识符。

必需:是

类型:字符串

Update requires: Replacement

CampaignHook

指定要用作活动的代码挂钩的 AWS Lambda 函数。

必需:否

类型CampaignHook

Update requires: No interruption

Description

活动的自定义描述。

必需:否

类型:字符串

Update requires: No interruption

HoldoutPercent

不应该从活动中接收消息的用户(分段成员)的分配百分比。

必需:否

类型:整数

Update requires: No interruption

IsPaused

指定是否暂停活动。除非您通过将此值更改为 false 来恢复暂停的活动,否则暂停的活动不会运行。

必需:否

类型:布尔值

Update requires: No interruption

Limits

活动的消息收发限制。

必需:否

类型限制

Update requires: No interruption

MessageConfiguration

活动的消息配置设置。

必需:是

类型MessageConfiguration

Update requires: No interruption

Name

活动的名称。

必需:是

类型:字符串

Update requires: No interruption

Schedule

活动的计划设置。

必需:是

类型计划

Update requires: No interruption

SegmentId

要与活动关联的分段的唯一标识符。

必需:是

类型:字符串

Update requires: No interruption

SegmentVersion

要与活动关联的分段的版本。

必需:否

类型:整数

Update requires: No interruption

Tags

键值对的字符串到字符串映射,该映射定义要与活动关联的标签。每个标签都包含一个必需的标签键和一个关联的标签值。

必需:否

类型:Json

Update requires: No interruption

TreatmentDescription

活动的默认处理的自定义描述。

必需:否

类型:字符串

Update requires: No interruption

TreatmentName

活动的默认处理的自定义名称(如果活动具有多个处理)。处理 是指用于 A/B 测试的活动变化。

必需:否

类型:字符串

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回一个字符串,它将 Amazon Pinpoint 应用程序的唯一标识符 (ApplicationId) 与活动定位的分段的唯一标识符合并在一起。

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

Fn::GetAtt

Fn::GetAtt 内部函数返回此类型的一个指定属性的值。以下为可用属性和示例返回值。

有关使用 Fn::GetAtt 内部函数的更多信息,请参阅 Fn::GetAtt

Arn

活动的 Amazon 资源名称 (ARN)。

CampaignId

活动的唯一标识符。