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",
  principal: "Principal",
  statement_id: "StatementId",
  condition: {
    type: "String", # required
    key: "String", # required
    value: "String", # required
  },
  policy: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action that you are enabling the other account to perform.

Returns:

  • (String)


4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4426

class PutPermissionRequest < Struct.new(
  :event_bus_name,
  :action,
  :principal,
  :statement_id,
  :condition,
  :policy)
  SENSITIVE = []
  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 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.

Returns:



4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4426

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

#event_bus_nameString

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

Returns:

  • (String)


4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4426

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

#policyString

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)


4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4426

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

#principalString

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)


4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4426

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

#statement_idString

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.

Each StatementId must be unique.

Returns:

  • (String)


4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4426

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