aws-cdk-lib.aws_events.CfnEventBusProps

interface CfnEventBusProps

LanguageType name
.NETAmazon.CDK.AWS.Events.CfnEventBusProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#CfnEventBusProps
Javasoftware.amazon.awscdk.services.events.CfnEventBusProps
Pythonaws_cdk.aws_events.CfnEventBusProps
TypeScript aws-cdk-lib » aws_events » CfnEventBusProps

Properties for defining a CfnEventBus.

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 cfnEventBusProps: events.CfnEventBusProps = {
  name: 'name',

  // the properties below are optional
  eventSourceName: 'eventSourceName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
namestringThe name of the new event bus.
eventSourceName?stringIf you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
tags?TagEntryProperty[]Tags to associate with the event bus.

name

Type: string

The name of the new event bus.

Custom event bus names can't contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.


eventSourceName?

Type: string (optional)

If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.


tags?

Type: TagEntryProperty[] (optional)

Tags to associate with the event bus.