CreateEventSubscription - Amazon DocumentDB
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

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-instanceSourceIds = mydbinstance1, mydbinstance2EventCategories = Availability, Backup

如果指定了SourceTypeSourceIds(例如SourceType = db-instanceSourceIdentifier = myDBInstance1),则会通知您所有db-instance事件。如果您指定SourceType但没有指定SourceIdentifier,则会收到您所有 Amazon DocumentDB 源的该源类型的事件通知。如果您没有为指定SourceTypeSourceIdentifier,则会收到属于您的客户账户的所有 Amazon DocumentDB 源所生成事件的通知。

请求参数

有关所有操作通用的参数的信息,请参阅常见参数

SnsTopicArn

为事件通知创建的 SNS 主题的 Amazon 资源名称 (ARN)。在您创建主题并订阅到该主题时,Amazon SNS 将创建 ARN。

类型: 字符串

:必需 是

SubscriptionName

订阅的名称。

约束:名称必须少于 255 个字符。

类型: 字符串

:必需 是

已启用

布尔值;设置为true以激活订阅,请设置为false创建订阅但未激活订阅。

类型: Boolean

:必需 否

事件类别。事件类别 .n

事件类别列表SourceType您要订阅的。

类型: 字符串数组

:必需 否

源代码。源代码 .n

为其返回事件的事件源的标识符列表。如果未指定,则响应中包含所有源。标识符必须以字母开头,并且只能包含 ASCII 字母、数字和连字符,不能以连字符结尾,也不能包含两个连续的连字符。

约束:

  • 如果SourceIds提供,SourceType还必须提供。

  • 如果源类型是实例,则会出现DBInstanceIdentifier必须提供。

  • 如果源类型是安全组,则DBSecurityGroupName必须提供。

  • 如果源类型是参数组,则DBParameterGroupName必须提供。

  • 如果源类型是快照,则会出现DBSnapshotIdentifier必须提供。

类型: 字符串数组

:必需 否

SourceType

生成事件的源的类型。例如,如果希望收到关于实例生成的事件的通知,请将该参数设置为db-instance。如果未指定该值,则将返回所有事件。

有效值:db-instancedb-clusterdb-parameter-groupdb-security-groupdb-cluster-snapshot

类型: 字符串

:必需 否

标签。标签 .N

要分配给事件订阅的标签。

类型: 数组Tagobjects

:必需 否

响应元素

服务返回以下元素。

EventSubscription

您订阅的事件的详细信息。

类型:EventSubscription 对象

Errors

有关所有操作常见错误的信息,请参阅常见错误

事件订阅超出配额

您已达到事件订阅的最大数量。

HTTP 状态代码:400

SN-无效主题

Amazon SNS 已回复指定主题存在问题。

HTTP 状态代码:400

SNS 无授权

您无权向 SNS 主题发布 Amazon 资源名称 (ARN)。

HTTP 状态代码:400

没有找到斯托迪卡

SNS 主题的 Amazon 资源名称 (ARN) 不存在。

HTTP 状态代码:404

找到来源

找不到请求的源。

HTTP 状态代码:404

订阅已经存在

提供的订阅名称已存在。

HTTP 状态代码:400

订阅类别未找到

提供的类别不存在。

HTTP 状态代码:404