Actions, resources, and condition keys for Amazon EventBridge
Amazon EventBridge (service prefix: events) provides the following
service-specific operations, resources, actions, and condition keys for use in IAM permission
policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon EventBridge
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
ActivateEventSource |
Write |
|||
|
CancelReplay |
Write |
|||
|
CreateApiDestination |
Write |
|||
|
CreateArchive |
Write |
|||
|
CreateConnection |
Write |
|||
|
CreateEndpoint |
Write |
|||
iam:PassedToService |
events.amazonaws.com |
Write |
||
|
CreateEventBus |
Write |
|||
Tagging, Write |
||||
|
CreatePartnerEventSource |
Write |
|||
|
DeactivateEventSource |
Write |
|||
|
DeauthorizeConnection |
Write |
|||
|
DeleteApiDestination |
Write |
|||
|
DeleteArchive |
Write |
|||
|
DeleteConnection |
Write |
|||
|
DeleteEndpoint |
Write |
|||
|
DeleteEventBus |
Write |
|||
|
DeletePartnerEventSource |
Write |
|||
|
DeleteRule |
Write |
|||
|
DescribeApiDestination |
Read |
|||
|
DescribeArchive |
Read |
|||
|
DescribeConnection |
Read |
|||
|
DescribeEndpoint |
Read |
|||
|
DescribeEventBus |
Read |
|||
|
DescribeEventSource |
Read |
|||
|
DescribePartnerEventSource |
Read |
|||
|
DescribeReplay |
Read |
|||
|
DescribeRule |
Read |
|||
|
DisableRule |
Write |
|||
|
EnableRule |
Write |
|||
|
ListApiDestinations |
List |
|||
|
ListArchives |
List |
|||
|
ListConnections |
List |
|||
|
ListEndpoints |
List |
|||
|
ListEventBuses |
List |
|||
|
ListEventSources |
List |
|||
|
ListPartnerEventSourceAccounts |
List |
|||
|
ListPartnerEventSources |
List |
|||
|
ListReplays |
List |
|||
|
ListRuleNamesByTarget |
List |
|||
|
ListRules |
List |
|||
|
ListTagsForResource |
List |
|||
|
ListTargetsByRule |
List |
|||
|
PutEvents |
Write |
|||
|
PutPartnerEvents |
Write |
|||
|
PutPermission |
Permissions management, Write |
|||
|
PutRule |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
events.amazonaws.com |
Write |
||
|
PutTargets |
Write |
|||
iam:PassedToService |
events.amazonaws.com |
Write |
||
|
RemovePermission |
Permissions management, Write |
|||
|
RemoveTargets |
Write |
|||
|
StartReplay |
Write |
|||
|
TagResource |
Tagging, Write |
|||
|
TestEventPattern |
Read |
|||
|
UntagResource |
Tagging, Write |
|||
|
UpdateApiDestination |
Write |
|||
|
UpdateArchive |
Write |
|||
|
UpdateConnection |
Write |
|||
|
UpdateEndpoint |
Write |
|||
iam:PassedToService |
events.amazonaws.com |
Write |
||
|
UpdateEventBus |
Write |
Actions defined by Amazon EventBridge
You can specify the following actions in the Action element of an IAM
policy statement. Use policies to grant permissions to perform an operation in Amazon. When
you use an action in a policy, you usually allow or deny access to the API operation or CLI
command with the same name. However, in some cases, a single action controls access to more
than one operation. Alternatively, some operations require several different actions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to activate partner event sources |
Write |
|||
Grants permission to cancel a replay |
Write |
|||
Grants permission to create a new api destination |
Write |
|||
Grants permission to create a new archive |
Write |
|||
Grants permission to create a new connection |
Write |
|||
Grants permission to create an endpoint |
Write |
|||
Grants permission to create event buses |
Write |
|||
event-busv2 |
||||
Grants permission to create partner event sources |
Write |
|||
Grants permission to deactivate event sources |
Write |
|||
Grants permission to deauthorize a connection, deleting its stored authorization secrets |
Write |
|||
Grants permission to delete an api destination |
Write |
|||
Grants permission to delete an archive |
Write |
|||
Grants permission to delete a connection |
Write |
|||
Grants permission to delete an endpoint |
Write |
|||
Grants permission to delete event buses |
Write |
|||
event-busv2 |
||||
Grants permission to delete partner event sources |
Write |
|||
Grants permission to delete rules |
Write |
|||
Grants permission to retrieve details about an api destination |
Read |
|||
Grants permission to retrieve details about an archive |
Read |
|||
Grants permission to retrieve details about a conection |
Read |
|||
Grants permission to retrieve details about an endpoint |
Read |
|||
Grants permission to retrieve details about event buses |
Read |
|||
event-busv2 |
||||
Grants permission to retrieve details about event sources |
Read |
|||
Grants permission to retrieve details about partner event sources |
Read |
|||
Grants permission to retrieve the details of a replay |
Read |
|||
Grants permission to retrieve details about rules |
Read |
|||
Grants permission to disable rules |
Write |
|||
Grants permission to enable rules |
Write |
|||
Grants permission to retrieve a list of api destinations |
List |
|||
Grants permission to retrieve a list of archives |
List |
|||
Grants permission to retrieve a list of connections |
List |
|||
Grants permission to retrieve a list of endpoints |
List |
|||
Grants permission to retrieve a list of the event buses in your account |
List |
|||
Grants permission to to retrieve a list of event sources shared with this account |
List |
|||
Grants permission to retrieve a list of Amazon Web Services account IDs associated with an event source |
List |
|||
Grants permission to retrieve a list partner event sources |
List |
|||
Grants permission to retrieve a list of replays |
List |
|||
Grants permission to retrieve a list of the names of the rules associated with a target |
List |
|||
Grants permission to retrieve a list of the Amazon EventBridge rules in the account |
List |
|||
Grants permission to retrieve a list of tags associated with an Amazon EventBridge resource |
List |
|||
event-busv2 |
||||
publisher |
||||
subscriber |
||||
Grants permission to retrieve a list of targets defined for a rule |
List |
|||
Grants permission to send custom events to Amazon EventBridge |
events:ResourceArn events:SystemMetadata/EventGroupId |
Write |
||
event-busv2 |
events:ResourceArn events:SystemMetadata/EventGroupId |
|||
Grants permission to sends custom events to Amazon EventBridge |
Write |
|||
Grants permission to use the PutPermission action to grants permission to another Amazon Web Services account to put events to your default event bus |
Permissions management, Write |
|||
Grants permission to create or updates rules |
Write |
|||
Grants permission to add targets to a rule |
Write |
|||
Grants permission to revoke the permission of another Amazon Web Services account to put events to your default event bus |
Permissions management, Write |
|||
Grants permission to removes targets from a rule |
Write |
|||
Grants permission to start a replay of an archive |
Write |
|||
Grants permission to add a tag to an Amazon EventBridge resource |
Tagging, Write |
|||
event-busv2 |
||||
publisher |
||||
subscriber |
||||
Grants permission to test whether an event pattern matches the provided event |
Read |
|||
Grants permission to remove a tag from an Amazon EventBridge resource |
Tagging, Write |
|||
event-busv2 |
||||
publisher |
||||
subscriber |
||||
Grants permission to update an api destination |
Write |
|||
Grants permission to update an archive |
Write |
|||
Grants permission to update a connection |
Write |
|||
Grants permission to update an endpoint |
Write |
|||
Grants permission to update event buses |
Write |
|||
event-busv2 |
Permission-only actions for Amazon EventBridge
The following actions are defined by Amazon EventBridge but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to configure vended log delivery for EventBridge |
Write |
|||
Grants permission to invoke an api destination |
Write |
|||
Grants permission to retrieve credentials from a connection |
Write |
Resource types defined by Amazon EventBridge
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:kms:${Region}:${Account}:alias/${Alias} |
||
arn:${Partition}:events:${Region}:${Account}:api-destination/${ApiDestinationName} |
||
arn:${Partition}:events:${Region}:${Account}:archive/${ArchiveName} |
||
arn:${Partition}:events:${Region}:${Account}:connection/${ConnectionName} |
||
arn:${Partition}:events:${Region}:${Account}:target/create-snapshot |
||
arn:${Partition}:events:${Region}:${Account}:endpoint/${EndpointName} |
||
arn:${Partition}:events:${Region}:${Account}:event-bus/${EventBusName} |
||
arn:${Partition}:events:${Region}::event-source/${EventSourceName} |
||
arn:${Partition}:kms:${Region}:${Account}:key/${KeyId} |
||
arn:${Partition}:events:${Region}:${Account}:target/reboot-instance |
||
arn:${Partition}:events:${Region}:${Account}:replay/${ReplayName} |
||
arn:${Partition}:events:${Region}:${Account}:rule/${EventBusName}/${RuleName} |
||
arn:${Partition}:events:${Region}:${Account}:rule/${RuleName} |
||
arn:${Partition}:events:${Region}:${Account}:target/stop-instance |
||
arn:${Partition}:events:${Region}:${Account}:target/terminate-instance |
Condition keys for Amazon EventBridge
Amazon EventBridge defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the allowed set of values for each of the tags to event bus and rule actions |
String |
|
Filters access by tag-value associated with the resource to event bus and rule actions |
String |
|
Filters access by the tags in the request to event bus and rule actions |
ArrayOfString |
|
Filters access by the ARN of the event buses that can be associated with an endpoint to CreateEndpoint and UpdateEndpoint actions |
ArrayOfARN |
|
Filters access by Amazon services. If a rule is created by an Amazon service on your behalf, the value is the principal name of the service that created the rule |
String |
|
Filters access by the ARN of a target that can be put to a rule to PutTargets actions. TargetARN doesn't include DeadLetterConfigArn |
ArrayOfARN |
|
Filters access by the account the rule was created in to rule actions |
String |
|
Filters access by the literal string of the detail-type of the event to PutEvents and PutRule actions |
ArrayOfString |
|
Filters access by the literal string for the detail.eventTypeCode field of the event to PutRule actions |
String |
|
Filters access by the literal string for the detail.service field of the event to PutRule actions |
String |
|
Filters access by the literal string for the detail.useridentity.principalid field of the event to PutRule actions |
String |
|
Filters access by whether the event was generated via API or cross-account bus invocation to PutEvents actions |
String |
|
Filters access by the Amazon service or Amazon partner event source that generated the event to PutEvents and PutRule actions. Matches the literal string of the source field of the event |
ArrayOfString |