interface CfnEventBusPolicyProps

Language	Type name
.NET	Amazon.CDK.AWS.Events.CfnEventBusPolicyProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnEventBusPolicyProps
Java	software.amazon.awscdk.services.events.CfnEventBusPolicyProps
Python	aws_cdk.aws_events.CfnEventBusPolicyProps
TypeScript	aws-cdk-lib » aws_events » CfnEventBusPolicyProps

Properties for defining a CfnEventBusPolicy.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html

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';

declare const statement: any;
const cfnEventBusPolicyProps: events.CfnEventBusPolicyProps = {
  statementId: 'statementId',

  // the properties below are optional
  action: 'action',
  condition: {
    key: 'key',
    type: 'type',
    value: 'value',
  },
  eventBusName: 'eventBusName',
  principal: 'principal',
  statement: statement,
};

Properties

Name	Type	Description
statementId	string	An identifier string for the external account that you are granting permissions to.
action?⚠️	string	The action that you are enabling the other account to perform.
condition?⚠️	IResolvable | ConditionProperty	This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization.
eventBusName?	string	The name of the event bus associated with the rule.
principal?⚠️	string	The 12-digit AWS account ID that you are permitting to put events to your default event bus.
statement?	any	A JSON string that describes the permission policy statement.

---

statementId

Type: string

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statementid

---

action?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-action

---

condition?⚠️

⚠️ Deprecated: this property has been deprecated

Type: IResolvable | ConditionProperty (optional)

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-condition

---

eventBusName?

Type: string (optional)

The name of the event bus associated with the rule.

If you omit this, the default event bus is used.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-eventbusname

---

principal?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

The 12-digit AWS 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-principal

---

statement?

Type: any (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbuspolicy.html#cfn-events-eventbuspolicy-statement