この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

EventRelayConfig

プラットフォームイベントと変更データキャプチャイベントを Salesforce から Amazon EventBridge にリレーする、イベントリレーの設定を表します。

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

EventRelayConfig コンポーネントのサフィックスは .eventRelay で、eventRelays フォルダーに保存されます。

バージョン

EventRelayConfig コンポーネントは、API バージョン 56.0 以降で使用できます。

特別なアクセスルール

この型をリリースおよび取得するには、「アプリケーションのカスタマイズ」権限が必要です。
更新できるのは state および relayOption 項目のみです。eventChannel や destinationResourceName は更新できません。

項目

項目名	説明
destinationResourceName	項目の型 string 説明必須。AWS アカウント情報を保存する指定ログイン情報の API 参照名。destinationResourceName 値には `callout:` プレフィックスが含まれます。例: `callout:MyRelayNamedCredential`
eventChannel	項目の型 string 説明必須。イベントリレーで使用されるイベントチャネルの完全名。例: `MyRelayChannel__chn`
label	項目の型 string 説明イベントリレーの表示ラベル。この表示ラベルは、ユーザーインターフェースに表示されます。イベントリレーについて説明する、意味のある表示ラベルを使用していることを確認します。表示ラベルは一意になるようにします。
relayOption	項目の型 string 説明システムがエラーから回復した後、イベントリレーを再開するためのオプションを含む JSON 符号化された文字列。このオプションは、最後にリレーされたイベントの後に、イベントリレーを再開できない場合に使用されます。使用可能な選択肢は次のとおりです。 `{\"ReplayRecovery\":\"LATEST\"}` — (デフォルト) イベントバスで受信した新規イベントからイベントのリレーを開始します。このオプションは、リレーのダウン中に欠落したイベントには関心がない場合に使用します。 `{\"ReplayRecovery\":\"EARLIEST\"}` — イベントバスに保存されているすべてのイベントを再送信し、その後、新規イベントをリレーします。イベントバスにはイベントが最大 3 日間保存されます。保存されているすべてのイベントを再処理して、欠落したイベントを確認する場合は、このオプションを使用します。
state	項目の型 EventRelayAdminState (string 型の列挙) 説明イベントリレーの実行状況。可能な値は次のとおりです。 `RUN` — イベントリレーが実行され、イベントメッセージが Salesforce から Amazon EventBridge に正常にリレーされています。 `PAUSE` — システム管理者がイベントリレーを一時停止しました。この状況の間は、イベントは Amazon EventBridge にリレーされません。現在の状況に関する情報はすべて保存されます。 `STOP` — (デフォルト) イベントリレーが停止され、イベントは Amazon EventBridge にリレーされません。現在の状況に関する情報は削除されます。この項目を指定しない場合、イベントリレーは、デフォルト状態の `STOP` で作成されます。イベントリレーの作成時にこの項目を指定する場合、設定できる有効な値は `STOP` のみです。
usageType	項目の型 string 説明将来の使用のために予約されています。

宣言的なメタデータの定義のサンプル

ファイル名が Carbon_Comparison_Relay.eventRelay の EventRelayConfig コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<EventRelayConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <destinationResourceName>callout:AWS_Account</destinationResourceName>
4    <eventChannel>Carbon_Comparison_Channel__chn</eventChannel>
5    <label>Carbon Comparison Relay</label>
6    <relayOption>{\"ReplayRecovery\":\"LATEST\"}</relayOption>
7    <state>STOP</state>
8</EventRelayConfig>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Carbon_Comparison_Relay</members>
5        <name>EventRelayConfig</name>
6    </types>
7    <version>60.0</version>
8</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド