Put Permission
eventbridge_put_permission | R Documentation |
Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus¶
Description¶
Running put_permission
permits the specified Amazon Web Services
account or Amazon Web Services organization to put events to the
specified event bus. Amazon EventBridge (CloudWatch Events) rules in
your account are triggered by these events arriving to an event bus in
your account.
For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
To enable multiple Amazon Web Services accounts to put events to your
event bus, run put_permission
once for each of these accounts. Or, if
all the accounts are members of the same Amazon Web Services
organization, you can run put_permission
once specifying Principal
as "*" and specifying the Amazon Web Services organization ID in
Condition
, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that
organization must specify a RoleArn
with proper permissions when they
use PutTarget
to add your account's event bus as a target. For more
information, see Sending and Receiving Events Between Amazon Web
Services
Accounts
in the Amazon EventBridge User Guide.
The permission policy on the event bus cannot exceed 10 KB in size.
Usage¶
Arguments¶
EventBusName
The name of the event bus associated with the rule. If you omit this, the default event bus is used.
Action
The action that you are enabling the other account to perform.
Principal
The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.
If you specify "*" without specifying
Condition
, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains anaccount
field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.StatementId
An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this
StatementId
when you runremove_permission
.Each
StatementId
must be unique.Condition
This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.
If you specify
Condition
with an Amazon Web Services organization ID, and specify "*" as the value forPrincipal
, you grant permission to all the accounts in the named organization.The
Condition
is a JSON string which must containType
,Key
, andValue
fields.Policy
A JSON string that describes the permission policy statement. You can include a
Policy
parameter in the request instead of using theStatementId
,Action
,Principal
, orCondition
parameters.
Value¶
An empty list.