Actions, resources, and condition keys for Amazon EventBridge
Amazon EventBridge (service prefix: events) provides the following service-specific resources, actions, and condition context 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.
Topics
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 AWS. 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.
The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.
The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.
Note
Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.
For details about the columns in the following table, see Actions table.
| Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions |
|---|---|---|---|---|---|
| ActivateEventSource | Grants permission to activate partner event sources | Write | |||
| CancelReplay | Grants permission to cancel a replay | Write | |||
| CreateApiDestination | Grants permission to create a new api destination | Write | |||
| CreateArchive | Grants permission to create a new archive | Write | |||
| CreateConnection | Grants permission to create a new connection | Write | |||
| CreateEndpoint | Grants permission to create an endpoint | Write | |||
| CreateEventBus | Grants permission to create event buses | Write | |||
| CreatePartnerEventSource | Grants permission to create partner event sources | Write | |||
| DeactivateEventSource | Grants permission to deactivate event sources | Write | |||
| DeauthorizeConnection | Grants permission to deauthorize a connection, deleting its stored authorization secrets | Write | |||
| DeleteApiDestination | Grants permission to delete an api destination | Write | |||
| DeleteArchive | Grants permission to delete an archive | Write | |||
| DeleteConnection | Grants permission to delete a connection | Write | |||
| DeleteEndpoint | Grants permission to delete an endpoint | Write | |||
| DeleteEventBus | Grants permission to delete event buses | Write | |||
| DeletePartnerEventSource | Grants permission to delete partner event sources | Write | |||
| DeleteRule | Grants permission to delete rules | Write | |||
| DescribeApiDestination | Grants permission to retrieve details about an api destination | Read | |||
| DescribeArchive | Grants permission to retrieve details about an archive | Read | |||
| DescribeConnection | Grants permission to retrieve details about a conection | Read | |||
| DescribeEndpoint | Grants permission to retrieve details about an endpoint | Read | |||
| DescribeEventBus | Grants permission to retrieve details about event buses | Read | |||
| DescribeEventSource | Grants permission to retrieve details about event sources | Read | |||
| DescribePartnerEventSource | Grants permission to retrieve details about partner event sources | Read | |||
| DescribeReplay | Grants permission to retrieve the details of a replay | Read | |||
| DescribeRule | Grants permission to retrieve details about rules | Read | |||
| DisableRule | Grants permission to disable rules | Write | |||
| EnableRule | Grants permission to enable rules | Write | |||
| InvokeApiDestination [permission only] | Grants permission to invoke an api destination | Write | |||
| ListApiDestinations | Grants permission to retrieve a list of api destinations | List | |||
| ListArchives | Grants permission to retrieve a list of archives | List | |||
| ListConnections | Grants permission to retrieve a list of connections | List | |||
| ListEndpoints | Grants permission to retrieve a list of endpoints | List | |||
| ListEventBuses | Grants permission to retrieve a list of the event buses in your account | List | |||
| ListEventSources | Grants permission to to retrieve a list of event sources shared with this account | List | |||
| ListPartnerEventSourceAccounts | Grants permission to retrieve a list of AWS account IDs associated with an event source | List | |||
| ListPartnerEventSources | Grants permission to retrieve a list partner event sources | List | |||
| ListReplays | Grants permission to retrieve a list of replays | List | |||
| ListRuleNamesByTarget | Grants permission to retrieve a list of the names of the rules associated with a target | List | |||
| ListRules | Grants permission to retrieve a list of the Amazon EventBridge rules in the account | List | |||
| ListTagsForResource | Grants permission to retrieve a list of tags associated with an Amazon EventBridge resource | List | |||
| ListTargetsByRule | Grants permission to retrieve a list of targets defined for a rule | List | |||
| PutEvents | Grants permission to send custom events to Amazon EventBridge | Write | |||
| PutPartnerEvents | Grants permission to sends custom events to Amazon EventBridge | Write | |||
| PutPermission | Grants permission to use the PutPermission action to grants permission to another AWS account to put events to your default event bus | Permissions management | |||
| PutRule | Grants permission to create or updates rules | Write | |||
| PutTargets | Grants permission to add targets to a rule | Write | |||
| RemovePermission | Grants permission to revoke the permission of another AWS account to put events to your default event bus | Permissions management | |||
| RemoveTargets | Grants permission to removes targets from a rule | Write | |||
| RetrieveConnectionCredentials [permission only] | Grants permission to retrieve credentials from a connection | Write | |||
| StartReplay | Grants permission to start a replay of an archive | Write | |||
| TagResource | Grants permission to add a tag to an Amazon EventBridge resource | Tagging | |||
| TestEventPattern | Grants permission to test whether an event pattern matches the provided event | Read | |||
| UntagResource | Grants permission to remove a tag from an Amazon EventBridge resource | Tagging | |||
| UpdateApiDestination | Grants permission to update an api destination | Write | |||
| UpdateArchive | Grants permission to update an archive | Write | |||
| UpdateConnection | Grants permission to update a connection | Write | |||
| UpdateEndpoint | Grants permission to update an endpoint | Write | |||
| UpdateEventBus | Grants permission to update event buses | 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. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.
| Resource types | ARN | Condition keys |
|---|---|---|
| event-source |
arn:${Partition}:events:${Region}::event-source/${EventSourceName}
|
|
| event-bus |
arn:${Partition}:events:${Region}:${Account}:event-bus/${EventBusName}
|
|
| rule-on-default-event-bus |
arn:${Partition}:events:${Region}:${Account}:rule/${RuleName}
|
|
| rule-on-custom-event-bus |
arn:${Partition}:events:${Region}:${Account}:rule/${EventBusName}/${RuleName}
|
|
| archive |
arn:${Partition}:events:${Region}:${Account}:archive/${ArchiveName}
|
|
| replay |
arn:${Partition}:events:${Region}:${Account}:replay/${ReplayName}
|
|
| connection |
arn:${Partition}:events:${Region}:${Account}:connection/${ConnectionName}
|
|
| api-destination |
arn:${Partition}:events:${Region}:${Account}:api-destination/${ApiDestinationName}
|
|
| endpoint |
arn:${Partition}:events:${Region}:${Account}:endpoint/${EndpointName}
|
|
| create-snapshot |
arn:${Partition}:events:${Region}:${Account}:target/create-snapshot
|
|
| reboot-instance |
arn:${Partition}:events:${Region}:${Account}:target/reboot-instance
|
|
| stop-instance |
arn:${Partition}:events:${Region}:${Account}:target/stop-instance
|
|
| terminate-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. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.
To view the global condition keys that are available to all services, see Available global condition keys.
| Condition keys | Description | Type |
|---|---|---|
| aws:RequestTag/${TagKey} | Filters access by the allowed set of values for each of the tags to event bus and rule actions | String |
| aws:ResourceTag/${TagKey} | Filters access by tag-value associated with the resource to event bus and rule actions | String |
| aws:TagKeys | Filters access by the tags in the request to event bus and rule actions | ArrayOfString |
| events:EventBusArn | Filters access by the ARN of the event buses that can be associated with an endpoint to CreateEndpoint and UpdateEndpoint actions | ArrayOfARN |
| events:ManagedBy | Filters access by AWS services. If a rule is created by an AWS service on your behalf, the value is the principal name of the service that created the rule | String |
| events:TargetArn | Filters access by the ARN of a target that can be put to a rule to PutTargets actions. TargetARN doesn't include DeadLetterConfigArn | ArrayOfARN |
| events:creatorAccount | Filters access by the account the rule was created in to rule actions | String |
| events:detail-type | Filters access by the literal string of the detail-type of the event to PutEvents and PutRule actions | String |
| events:detail.eventTypeCode | Filters access by the literal string for the detail.eventTypeCode field of the event to PutRule actions | String |
| events:detail.service | Filters access by the literal string for the detail.service field of the event to PutRule actions | String |
| events:detail.userIdentity.principalId | Filters access by the literal string for the detail.useridentity.principalid field of the event to PutRule actions | String |
| events:eventBusInvocation | Filters access by whether the event was generated via API or cross-account bus invocation to PutEvents actions | String |
| events:source | Filters access by the AWS service or AWS partner event source that generated the event to PutEvents and PutRule actions. Matches the literal string of the source field of the event | ArrayOfString |
