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