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

Class: Aws::CloudWatchEvents::Types::Condition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/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 that you can use to limit the event bus permissions that you're granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the AWS organization. The following is an example value for Condition:

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

Instance Attribute Summary collapse

Instance Attribute Details

#keyString

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

Returns:

  • (String)


203
204
205
206
207
208
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 203

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

#typeString

The type of condition. Currently, the only supported value is StringEquals.

Returns:

  • (String)


203
204
205
206
207
208
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 203

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

#valueString

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

Returns:

  • (String)


203
204
205
206
207
208
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 203

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