Using roles to create secrets for API destinations in EventBridge - Amazon EventBridge
Service-linked role permissionsCreating a service-linked roleEditing a service-linked roleDeleting a service-linked roleSupported Regions
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Using roles to create secrets for API destinations in EventBridge

The following topic details usage of the AWSServiceRoleForAmazonEventBridgeApiDestinations service-linked role.

Service-linked role permissions for EventBridge

EventBridge uses the service-linked role named AWSServiceRoleForAmazonEventBridgeApiDestinations – Enables access to the Secrets Manager Secrets created by EventBridge.

The AWSServiceRoleForAmazonEventBridgeApiDestinations service-linked role trusts the following services to assume the role:

  • apidestinations.events.amazonaws.com

The role permissions policy named AmazonEventBridgeApiDestinationsServiceRolePolicy allows EventBridge to complete the following actions on the specified resources:

  • Action: create, describe, update and delete secrets; get and put secret values on secrets created for all connections by EventBridge

You must configure permissions to allow your users, groups, or roles to create, edit, or delete a service-linked role. For more information, see Service-linked role permissions in the IAM User Guide.

Creating a service-linked role for EventBridge

You don't need to manually create a service-linked role. When you create a connection in the Amazon Web Services Management Console, the Amazon CLI, or the Amazon API, EventBridge creates the service-linked role for you.

Important

This service-linked role can appear in your account if you completed an action in another service that uses the features supported by this role. If you were using the EventBridge service before February 11, 2021, when it began supporting service-linked roles, then EventBridge created the AWSServiceRoleForAmazonEventBridgeApiDestinations role in your account. To learn more, see A new role appeared in my Amazon Web Services account.

If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you create a connection, EventBridge creates the service-linked role for you again.

Editing a service-linked role for EventBridge

EventBridge does not allow you to edit the AWSServiceRoleForAmazonEventBridgeApiDestinations service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a service-linked role in the IAM User Guide.

Deleting a service-linked role for EventBridge

If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must clean up your service-linked role before you can manually delete it.

Cleaning up a service-linked role

Before you can use IAM to delete a service-linked role, you must first delete any resources used by the role.

Note

If the EventBridge service is using the role when you try to delete the resources, then the deletion might fail. If that happens, wait for a few minutes and try the operation again.

To delete EventBridge resources used by the AWSServiceRoleForAmazonEventBridgeApiDestinations (console)

  1. Open the Amazon EventBridge console at https://console.amazonaws.cn/events/.

  2. Under Integrations choose API destinations, then choose the Connections tab.

  3. Choose the connection, then choose Delete.

To delete EventBridge resources used by the AWSServiceRoleForAmazonEventBridgeApiDestinations (Amazon CLI)
To delete EventBridge resources used by the AWSServiceRoleForAmazonEventBridgeApiDestinations (API)

Manually delete the service-linked role

Use the IAM console, the Amazon CLI, or the Amazon API to delete the AWSServiceRoleForAmazonEventBridgeApiDestinations service-linked role. For more information, see Deleting a service-linked role in the IAM User Guide.

Supported Regions for EventBridge service-linked roles

EventBridge supports using service-linked roles in all of the Regions where the service is available. For more information, see Amazon Regions and endpoints.