CreateEventSubscription - Amazon DocumentDB

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

CreateEventSubscription

建立 Amazon DocumentDB 事件通知訂閱。此動作需要使用 Amazon DocumentDB 主控台、Amazon SNS 主控台或 Amazon SNS API 建立的 Amazon Resource Name (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 來源所產生的事件。

請求參數

如需所有動作的一般參數資訊,請參閱《Common Parameters》。

SnsTopicArn

針對事件通知所建立 SNS 主題的 Amazon Resource Name (ARN)。當您建立主題並訂閱主題時,Amazon SNS 會建立 ARN。

類型:字串

必要:是

SubscriptionName

訂閱的名稱。

限制條件:名稱必須少於 255 個字元。

類型:字串

必要:是

Enabled

布林值;設定為 true 以啟用訂閱,設定為 false 以建立訂閱,但非作用中。

類型:布林值

必要:否

EventCategories.EventCategory.N

SourceType 您要訂閱之 的事件類別清單。

類型:字串陣列

必要:否

SourceIds.SourceId.N

傳回事件的事件來源識別碼清單。如未指定,回應中會包含所有來源。識別碼必須以字母開頭,只能包含 ASCII 字母、數字和連字號,而且不得以連字號結尾,或連續包含兩個連字號。

約束:

  • 如果 SourceIds 已提供,SourceType則也必須提供 。

  • 如果來源類型是執行個體,DBInstanceIdentifier則必須提供 。

  • 如果來源類型是安全群組,DBSecurityGroupName則必須提供 。

  • 如果來源類型是參數群組,DBParameterGroupName則必須提供 。

  • 如果來源類型是快照,DBSnapshotIdentifier則必須提供 。

類型:字串陣列

必要:否

SourceType

產生事件的來源類型。例如,如果您想要收到執行個體產生事件的通知,請將此參數設定為 db-instance。若沒有指定此值,則會傳回所有事件。

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

類型:字串

必要:否

Tags.Tag.N

要指派給事件訂閱的標籤。

類型:Tag 物件陣列

必要:否

回應元素

服務會傳回下列元素。

EventSubscription

您已訂閱之事件的詳細資訊。

類型:EventSubscription 物件

錯誤

如需所有動作常見錯誤的資訊,請參閱常見錯誤

EventSubscriptionQuotaExceeded

您已達到事件訂閱的數量上限。

HTTP 狀態碼:400

SNSInvalidTopic

Amazon SNS 已回應指定的主題發生問題。

HTTP 狀態碼:400

SNSNoAuthorization

您沒有發佈至 SNS 主題 Amazon Resource Name (ARN) 的許可。

HTTP 狀態碼:400

SNSTopicArnNotFound

SNS 主題 Amazon Resource Name (ARN) 不存在。

HTTP 狀態碼:404

SourceNotFound

找不到請求的來源。

HTTP 狀態碼:404

SubscriptionAlreadyExist

提供的訂閱名稱已存在。

HTTP 狀態碼:400

SubscriptionCategoryNotFound

提供的類別不存在。

HTTP 狀態碼:404

另請參閱

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱以下內容: