You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EventBridge::Types::PutPermissionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

Overview

Note:

When making an API call, you may pass PutPermissionRequest data as a hash:

{
  event_bus_name: "NonPartnerEventBusName",
  action: "Action", # required
  principal: "Principal", # required
  statement_id: "StatementId", # required
  condition: {
    type: "String", # required
    key: "String", # required
    value: "String", # required
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action that you're enabling the other account to perform. Currently, this must be events:PutEvents.

Returns:

  • (String)


1727
1728
1729
1730
1731
1732
1733
1734
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1727

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition)
  include Aws::Structure
end

#conditionTypes::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 that must contain Type, Key, and Value fields.

Returns:



1727
1728
1729
1730
1731
1732
1733
1734
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1727

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition)
  include Aws::Structure
end

#event_bus_nameString

The event bus associated with the rule. If you omit this, the default event bus is used.

Returns:

  • (String)


1727
1728
1729
1730
1731
1732
1733
1734
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1727

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition)
  include Aws::Structure
end

#principalString

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 might 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 to receive events from. Rules that have an account field match events sent only from accounts that are listed in the rule's account field.

Returns:

  • (String)


1727
1728
1729
1730
1731
1732
1733
1734
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1727

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition)
  include Aws::Structure
end

#statement_idString

An identifier string for the external account that you're granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

Returns:

  • (String)


1727
1728
1729
1730
1731
1732
1733
1734
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1727

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition)
  include Aws::Structure
end