aws-cdk-lib.aws_events.CfnEventBusPolicy.ConditionProperty

interface ConditionProperty

LanguageType name
.NETAmazon.CDK.AWS.Events.CfnEventBusPolicy.ConditionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnEventBusPolicy_ConditionProperty
Javasoftware.amazon.awscdk.services.events.CfnEventBusPolicy.ConditionProperty
Pythonaws_cdk.aws_events.CfnEventBusPolicy.ConditionProperty
TypeScript aws-cdk-lib » 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 { aws_events as events } from 'aws-cdk-lib';
const conditionProperty: events.CfnEventBusPolicy.ConditionProperty = {
  key: 'key',
  type: 'type',
  value: 'value',
};

Properties

NameTypeDescription
key?stringSpecifies the key for the condition.
type?stringSpecifies the type of condition.
value?stringSpecifies 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.