class EventBusPolicy (construct)

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

Implements IConstruct, IDependable, IResource

The policy for an Event Bus.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called addToResourcePolicy(), which will automatically create a new resource policy if one doesn't exist yet, otherwise it will add to the existing policy.

Prefer to use addToResourcePolicy() instead.

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';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const eventBus: events.EventBus;
declare const policyStatement: iam.PolicyStatement;
const eventBusPolicy = new events.EventBusPolicy(this, 'MyEventBusPolicy', {
  eventBus: eventBus,
  statement: policyStatement,
  statementId: 'statementId',
});

Initializer

new EventBusPolicy(scope: Construct, id: string, props: EventBusPolicyProps)

Parameters

• scope Construct
• id string
• props EventBusPolicyProps

Construct Props

Name	Type	Description
eventBus	IEventBus	The event bus to which the policy applies.
statement	PolicyStatement	An IAM Policy Statement to apply to the Event Bus.
statementId	string	An identifier string for the external account that you are granting permissions to.

---

eventBus

Type: IEventBus

The event bus to which the policy applies.

---

statement

Type: PolicyStatement

An IAM Policy Statement to apply to the Event Bus.

---

statementId

Type: string

An identifier string for the external account that you are granting permissions to.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.