本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
CreateEventSubscription
創建一個 Amazon DocumentDB 事件通知訂閱。此動作需要使用 Amazon DocumentDB 主控台、Amazon SNS 主控台或 Amazon SNS API 建立的主題亞馬遜資源名稱 (ARN)。若要透過 Amazon SNS 取得 ARN,您必須在 Amazon SNS 中建立主題並訂閱該主題。ARN 會顯示在 Amazon SNS 主控台中。
您可以指定要通知的 source (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 來源產生的事件。
請求參數
如需所有動作的一般參數資訊,請參閱《Common Parameters》。
- SnsTopicArn
-
針對事件通知所建立 SNS 主題的 Amazon Resource Name (ARN)。當您建立主題並訂閱主題時,Amazon SNS 會建立 ARN。
類型:字串
必要:是
- SubscriptionName
-
訂閱的名稱。
限制:名稱必須少於 255 個字元。
類型:字串
必要:是
- Enabled
-
Boolean 值;設定
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
類型:字串
必要:否
- 標籤. 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
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: