Skip to content
v2.275.0

CfnEventBusPolicyProps Struct ​

Properties for defining a CfnEventBusPolicy.

Example ​

ts
// 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 ​

actionoptionalstringactionoptionalstractionoptionalStringActionoptionalstringActionoptional*stringdeprecated#
this property has been deprecated
conditionoptionalIResolvable | CfnEventBusPolicy.ConditionPropertyconditionoptionaltyping.Union[IResolvable, ConditionProperty]conditionoptionalIResolvableConditionoptionalIResolvableConditionoptionalinterface{}deprecated#
this property has been deprecated
eventBusNameoptionalstringevent_bus_nameoptionalstreventBusNameoptionalStringEventBusNameoptionalstringEventBusNameoptional*string#
The name of the event bus associated with the rule.

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

principaloptionalstringprincipaloptionalstrprincipaloptionalStringPrincipaloptionalstringPrincipaloptional*stringdeprecated#
this property has been deprecated

Specify "*" to permit any account to put events to your default event bus.

statementoptionalanystatementoptionalAnystatementoptionalObjectStatementoptionalobjectStatementoptionalinterface{}#
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.

statementIdstringstatement_idstrstatementIdStringStatementIdstringStatementId*stringrequired#
An identifier string for the external account that you are granting permissions to.
notes

If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission .

Each StatementId must be unique.