You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EventBridge::Types::PutPermissionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EventBridge::Types::PutPermissionRequest
- Defined in:
- (unknown)
Overview
When passing PutPermissionRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
event_bus_name: "NonPartnerEventBusName",
action: "Action",
principal: "Principal",
statement_id: "StatementId",
condition: {
type: "String", # required
key: "String", # required
value: "String", # required
},
policy: "String",
}
Instance Attribute Summary collapse
-
#action ⇒ String
The action that you are enabling the other account to perform.
-
#condition ⇒ Types::Condition
This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization.
-
#event_bus_name ⇒ String
The name of the event bus associated with the rule.
-
#policy ⇒ String
A JSON string that describes the permission policy statement.
-
#principal ⇒ String
The 12-digit AWS account ID that you are permitting to put events to your default event bus.
-
#statement_id ⇒ String
An identifier string for the external account that you are granting permissions to.
Instance Attribute Details
#action ⇒ String
The action that you are enabling the other account to perform.
Currently, this must be events:PutEvents
.
#condition ⇒ Types::Condition
This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.
If you specify Condition
with an AWS 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.
#event_bus_name ⇒ String
The name of the event bus associated with the rule. If you omit this, the default event bus is used.
#policy ⇒ String
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.
#principal ⇒ String
The 12-digit AWS 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.
#statement_id ⇒ String
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
RemovePermission.