paws.application.integration (version 0.8.0)

eventbridge_put_permission: 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 rules in your account are triggered by these events arriving to an event bus in your account.

See https://www.paws-r-sdk.com/docs/eventbridge_put_permission/ for full documentation.

Usage

eventbridge_put_permission(
  EventBusName = NULL,
  Action = NULL,
  Principal = NULL,
  StatementId = NULL,
  Condition = NULL,
  Policy = NULL
)

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 an account 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 run remove_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 for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string which must contain Type, Key, and Value fields.

Policy

A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.