--- schema_version: "1" id: 37061dc67e6c44f62eb80e2462aa2c294230583a6c6ad7e3ecad874ece5224a2 title: EventRelayConfig collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_eventrelayconfig.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_eventrelayconfig.htm source_site: developer.salesforce.com content_type: documentation content_hash: 16c32f7c1ad8ad6c21a5d3cfb1e5f38c23f02d1852cfb85ce4820da1241d8bc1 description: Represents the configuration of an event relay, which relays platform events and change data capture events from Salesforce to Amazon EventBridge. This object is available in API version 56.0 and later. --- # EventRelayConfig Represents the configuration of an event relay, which relays platform events and change data capture events from Salesforce to Amazon EventBridge. This object is available in API version 56.0 and later. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Special Access Rules - To retrieve or query this object, you must have the View Setup and Configuration permission. - To create, update, or delete this object, you must have the Customize Application permission. - You can update only the state and relayOption fields and not eventChannel or destinationResourceName. Update the state and relayOption fields through the Metadata field. ## Fields | Field | Details | | --- | --- | | DestinationResourceName | Type string Properties Filter, Group, Sort Description The developer name of the named credential, which stores the AWS account information. The destinationResourceName value contains the callout: prefix. For example: callout:MyRelayNamedCredential | | DeveloperName | Type string Properties Filter, Group, Sort Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is **Record Type Name**. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. | | EventChannel | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The full name of the event channel used in the event relay. For example: MyRelayChannel\_\_chn | | FullName | Type string Properties Create, Group, Nillable Description The full name of the associated EventRelayConfig in Metadata API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. | | Language | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the EventRelayConfig. Possible values are: - da—Danish - de—German - en\_US—English - es—Spanish - es\_MX—Spanish (Mexico) - fi—Finnish - fr—French - it—Italian - ja—Japanese - ko—Korean - nl\_NL—Dutch - no—Norwegian - pt\_BR—Portuguese (Brazil) - ru—Russian - sv—Swedish - th—Thai - zh\_CN—Chinese (Simplified) - zh\_TW—Chinese (Traditional) | | ManageableState | Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: - beta - deleted - deprecated - deprecatedEditable - installed - installedEditable - released - unmanaged | | MasterLabel | Type string Properties Filter, Group, Sort Description The label for the event relay, which corresponds to the label of the EventRelayConfig metadata type. The label is displayed in the user interface. If the label isn't provided in the metadata type, MasterLabel is the DeveloperName value. | | Metadata | Type [EventRelayConfig](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_eventrelayconfig.htm) Properties Create, Nillable, Update Description The EventRelayConfig’s metadata. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. The namespace prefix can have one of the following values: - In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. - In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects. | | RelayOption | Type textarea Properties Nillable Description A JSON-encoded string that contains an option for resuming an event relay after the system recovers from an error. This option is used if the event relay can't resume after the last relayed event. The options available are: - "{"ReplayRecovery":"LATEST"}"—(Default) Start relaying events from new events received in the event bus. Use this option if you aren’t interested in missed events while the relay was down. - "{"ReplayRecovery":"EARLIEST"}"—Resend all events stored in the event bus and relay new events thereafter. The event bus stores events for up to three days. Use this option if you want to reprocess all stored events and catch up on missed events. | | State | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The execution state of the event relay. Possible values are: - RUN—The event relay is running and actively relaying event messages from Salesforce to Amazon EventBridge. - PAUSE—An administrator paused the event relay. No events are relayed to Amazon EventBridge during this status. All current state information is saved. - STOP—(Default) The event relay is stopped and no events are relayed to Amazon EventBridge. All current state information is deleted. - DELETE—Reserved for future use. | | UsageType | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Reserved for future use. | ## Usage This JSON example is the body of a REST API POST request that creates an event relay named MyEventRelay. It includes the optional fields relayOption and state. The corresponding REST endpoint is /services/data/v68.0/tooling/sobjects/EventRelayConfig. { "FullName": "Carbon\_Comparison\_Relay", "Metadata": { "destinationResourceName": "callout:AWS\_Account", "eventChannel": "Carbon\_Comparison\_Channel\_\_chn", “label”: “Carbon Comparison Relay”, "relayOption": "{"ReplayRecovery":"LATEST"}", "state": "STOP" } }