本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CreateEventSubscription
创建 Amazon DocumentDB 事件通知订阅。此操作需要一个通过使用 Amazon DocumentDB 控制台、Amazon SNS 控制台或 Amazon SNS API 创建的主题的 Amazon 资源名称 (ARN)。要通过 Amazon SNS 获取 ARN,您必须在 Amazon SNS 中创建主题并订阅该主题。ARN 显示在 Amazon SNS 控制台中。
您可以指定源的类型 (SourceType
)您希望收通知的。您还可以提供 Amazon DocumentDB 来源列表(SourceIds
) 触发事件,您可以提供事件类别列表(EventCategories
)对于您希望收通知的事件。例如,您可以指定SourceType = db-instance
、SourceIds = mydbinstance1, mydbinstance2
和EventCategories = Availability, Backup
.
如果您同时指定SourceType
和SourceIds
(例如SourceType = db-instance
和SourceIdentifier = myDBInstance1
),您将收到所有db-instance
指定源的事件。如果你指定SourceType
但是不要指定SourceIdentifier
,则会收到您所有 Amazon DocumentDB 源的该源类型的事件通知。如果未指定SourceType
或者SourceIdentifier
,系统会收到从属于您的客户账户的所有 Amazon DocumentDB 源中生成的事件通知。
请求参数
有关所有操作通用的参数的信息,请参阅常见参数.
- SnsTopicArn
-
为事件通知创建的 SNS 主题的 Amazon 资源名称 (ARN)。在您创建主题并订阅到该主题时,Amazon SNS 会创建 ARN。
类型: 字符串
:必需 是
- SubscriptionName
-
订阅的名称。
约束:名称必须少于 255 个字符。
类型: 字符串
:必需 是
- Enabled
-
布尔值;设置为
true
要激活订阅,请设置为false
来创建订阅但不激活该订阅。类型: Boolean
:必需 否
- 活动类别。EVENTCATEGY.N
-
对于是一个事件类别列表
SourceType
您要订阅。类型: 字符串数组
:必需 否
- sourceids.sourceid.Sourceidn。
-
为其返回事件的事件源的标识符列表。如果未指定,则响应中包含所有源。标识符必须以字母开头,并且只能包含 ASCII 字母、数字和连字符,不能以连字符结尾,也不能包含两个连续的连字符。
约束:
-
如果
SourceIds
已提供,SourceType
还必须提供。 -
如果源类型是实例,则
DBInstanceIdentifier
必须提供。 -
如果源类型是安全组,则
DBSecurityGroupName
必须提供。 -
如果源类型是参数组,则
DBParameterGroupName
必须提供。 -
如果源类型是快照,则
DBSnapshotIdentifier
必须提供。
类型: 字符串数组
:必需 否
-
- SourceType
-
生成事件的源的类型。例如,如果希望收到关于实例生成的事件的通知,则应将此参数设置为。
db-instance
. 如果未指定该值,则将返回所有事件。有效值:
db-instance
,db-cluster
,db-parameter-group
,db-security-group
,db-cluster-snapshot
类型: 字符串
:必需 否
- 标签 s.Tag.N
-
要分配给事件订阅的标签。
类型: 数组Tag对象
:必需 否
响应元素
服务返回以下元素。
- EventSubscription
-
您订阅的事件的详细信息。
类型:EventSubscription 对象
错误
有关所有操作中常见的错误的信息,请参阅常见错误.
- EventSubscriptionQuotaExceeded
-
您已达到事件订阅的最大数量。
HTTP 状态代码:400
- SNSInvalidTopic
-
Amazon SNS 回应说,指定主题存在问题。
HTTP 状态代码:400
- SNSNoAuthorization
-
您没有向 SNS 发布的 Amazon 资源名称 (ARN) 的权限。
HTTP 状态代码:400
- SNSTopicArnNotFound
-
SNS 主题的 Amazon 资源名称 (ARN) 不存在。
HTTP 状态代码:404
- SourceNotFound
-
找不到请求的源。
HTTP 状态代码:404
- SubscriptionAlreadyExist
-
提供的订阅名称已存在。
HTTP 状态代码:400
- SubscriptionCategoryNotFound
-
提供的类别不存在。
HTTP 状态代码:404
另请参阅
有关在特定语言的Amazon软件开发工具包中使用此 API 的更多信息,请参阅以下内容: