interface ConditionProperty

Language	Type name
.NET	Amazon.CDK.AWS.Events.CfnEventBusPolicy.ConditionProperty
Java	software.amazon.awscdk.services.events.CfnEventBusPolicy.ConditionProperty
Python	aws_cdk.aws_events.CfnEventBusPolicy.ConditionProperty
TypeScript	@aws-cdk/aws-events » CfnEventBusPolicy » ConditionProperty

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 AWS organization. The string must contain Type , Key , and Value fields. The Value field specifies the ID of the AWS organization. Following is an example value for Condition :

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as events from '@aws-cdk/aws-events';
const conditionProperty: events.CfnEventBusPolicy.ConditionProperty = {
  key: 'key',
  type: 'type',
  value: 'value',
};

Properties

Name	Type	Description
key?	string	Specifies the key for the condition.
type?	string	Specifies the type of condition.
value?	string	Specifies the value for the key.

---

key?

Type: string (optional)

Specifies the key for the condition.

Currently the only supported key is aws:PrincipalOrgID .

---

type?

Type: string (optional)

Specifies the type of condition.

Currently the only supported value is StringEquals .

---

value?

Type: string (optional)

Specifies the value for the key.

Currently, this must be the ID of the organization.