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 indicates whether each action supports resource-level permissions. If
there is no value for this column, you must specify all resources ("*") 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. Required
resources are indicated in the table with an asterisk (*). If you specify a resource-level
permission ARN in a statement using this action, then it must be of this type.
Some actions support multiple resource types. If the resource type is optional (not
indicated as required), then you can choose to use one but not the other.
For details about the columns in the following table, see The 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 | |||
CreateArchive | Grants permission to create a new archive | 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 | |||
DeleteArchive | Grants permission to delete an archive | 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 | |||
DescribeArchive | Grants permission to retrieve details about an archive | 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 permissions to enable rules | Write | |||
ListArchives | Grants permission to retrieve a list of archives | List | |||
ListEventBuses | Grants permission to 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 | Write | |||
PutRule | Grants permission to create or updates rules | Tagging | |||
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 | Write | |||
RemoveTargets | Grants permission to removes targets from a rule | 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 permissions to test whether an event pattern matches the provided event | Read | |||
UntagResource | Grants permission to remove a tag from an Amazon EventBridge resource | Tagging | |||
UpdateArchive | Grants permission to update an archive | 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 table. For details about the columns
in the following table, see
The 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 |
arn:$
{
Partition}:events:$
{
Region}:$
{
Account}:rule/[$
{
EventBusName}/]$
{
RuleName}
|
|
archive |
arn:$
{
Partition}:events:$
{
Region}:$
{
Account}:archive/$
{
ArchiveName}
|
|
replay |
arn:$
{
Partition}:events:$
{
Region}:$
{
Account}:replay/$
{
ReplayName}
|
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
The 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 actions based on the allowed set of values for each of the tags | String |
aws:ResourceTag/${TagKey} | Filters actions based on tag-value associated with the resource | String |
aws:SourceAccount | Filters actions based on whether the source of the request comes from a specific account | String |
aws:SourceArn | Filters actions based on the Amazon Resource Name (ARN) of the source making the request | String |
aws:TagKeys | Filters actions based on the presence of mandatory tags in the request | String |
events:ManagedBy | Used internally 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 | The ARN of a target that can be put to a rule. | ARN |
events:creatorAccount | Filters actions based on the account the rule was created in | String |
events:detail-type | Matches the literal string of the detail-type filed of the event. | String |
events:detail.eventTypeCode | Matches the literal string for the detail.eventTypeCode field of the event. | String |
events:detail.service | Matches the literal string for the detail.service field of the event. | String |
events:detail.userIdentity.principalId | Matches the literal string for the detail.useridentity.principalid field of the event. | String |
events:eventBusInvocation | Filters actions based on whether the event was generated via API or cross-account bus invocation | String |
events:source | The AWS service or AWS partner event source that generated the event. Matches the literal string of the source field of the event. | String |