翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateEventSubscription
Amazon DocumentDB のイベント通知サブスクリプションを作成します。このアクションには、Amazon DocumentDB コンソール、Amazon SNS コンソール、または Amazon SNS API を使用して作成したトピック 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 SourceType] を指定し、[SourceIdentifier SourceIdentifier] を指定しない場合、指定したAmazon DocumentDB ソースのすべてのイベント通知を受け取ります。SourceType も SourceIdentifier も指定しない場合、顧客アカウントに属する Amazon DocumentDB ソースから生成されたすべてのイベントの通知を受け取ります。
リクエストパラメーター
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
- SnsTopicArn
-
イベント通知用に作成された SNS トピックの Amazon リソースネーム (ARN)。ARN は、トピックを作成してそれをサブスクライブするときに Amazon SNS によって作成されます。
タイプ: 文字列
必須: はい
- SubscriptionName
-
サブスクリプションの名前。
制約: この名前は 255 文字未満である必要があります。
タイプ: 文字列
必須: はい
- Enabled
-
ブール値。サブスクリプションを有効にする場合は
trueに設定し、サブスクリプションを作成するが有効にしない場合はfalseに設定します。型: ブール値
必須: いいえ
- EventCategories.EventCategory.N
-
サブスクライブする
SourceTypeのイベントカテゴリのリスト。型: 文字列の配列
必須: いいえ
- SourceIds.SourceId.N
-
イベントが返されるイベントソースの識別子のリスト。指定しない場合は、すべてのソースはレスポンスに含まれます。識別子は文字で開始し、ASCII 文字、数字、ハイフンのみを使用できます。最後の文字をハイフンにすることはできず、ハイフンを 2 つ続けて使用することもできません。
制約:
-
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 トピックの Amazon リソースネーム (ARN) が存在しません。
HTTP ステータスコード: 404
- SourceNotFound
-
リクエストされたリソースが見つかりませんでした。
HTTP ステータスコード: 404
- SubscriptionAlreadyExist
-
指定されたサブスクリプション名はすでに存在します。
HTTP ステータスコード: 400
- SubscriptionCategoryNotFound
-
指定されたカテゴリは存在しません。
HTTP ステータスコード: 404
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
