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

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::PutPermissionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-eventbridge/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 Amazon Web Services 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 Amazon Web Services 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.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4147

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#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 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.

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html

Returns:

• (Types::Condition)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4147

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#event_bus_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4147

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4147

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#principal ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4147

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#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].

<note markdown=“1”> Each ‘StatementId` must be unique.

</note>

[1]: docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4147

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end