AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::EventBridge::Types::Condition

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 Condition data as a hash:

{
  type: "String", # required
  key: "String", # required
  value: "String", # required
}

A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain Amazon Web Services organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the Amazon Web Services organization. Following is an example value for Condition:

'\{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"\}'

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

Specifies the key for the condition. Currently the only supported key is aws:PrincipalOrgID.

Returns:

  • (String)


410
411
412
413
414
415
416
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 410

class Condition < Struct.new(
  :type,
  :key,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

Specifies the type of condition. Currently the only supported value is StringEquals.

Returns:

  • (String)


410
411
412
413
414
415
416
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 410

class Condition < Struct.new(
  :type,
  :key,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#valueString

Specifies the value for the key. Currently, this must be the ID of the organization.

Returns:

  • (String)


410
411
412
413
414
415
416
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 410

class Condition < Struct.new(
  :type,
  :key,
  :value)
  SENSITIVE = []
  include Aws::Structure
end