AWS CDK Reference

Appearance

v2.274.0

CfnEventBusProps Struct ​

Properties for defining a CfnEventBus.

Source
Generated code
Type last changed
v2.208.0 · 29 Jul 2025

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

  // the properties below are optional
  deadLetterConfig: {
    arn: 'arn',
  },
  description: 'description',
  eventSourceName: 'eventSourceName',
  kmsKeyIdentifier: 'kmsKeyIdentifier',
  logConfig: {
    includeDetail: 'includeDetail',
    level: 'level',
  },
  policy: policy,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

deadLetterConfigIResolvable | CfnEventBus.DeadLetterConfigPropertydead_letter_configtyping.Union[IResolvable, DeadLetterConfigProperty]deadLetterConfigIResolvableDeadLetterConfigIResolvableDeadLetterConfiginterface{}#
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide .

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
The event bus description.
eventSourceNamestringevent_source_namestreventSourceNameStringEventSourceNamestringEventSourceName*string#
If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
kmsKeyIdentifierstringkms_key_identifierstrkmsKeyIdentifierStringKmsKeyIdentifierstringKmsKeyIdentifier*string#
The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus.
notes

The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt events on the event bus.

For more information, see Identify and view keys in the AWS Key Management Service Developer Guide .

Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

  • You call [CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer) on an event bus set to use a customer managed key for encryption.
  • You call [UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html) to set a customer managed key on an event bus with schema discovery enabled.

To enable schema discovery on an event bus, choose to use an AWS owned key . For more information, see Encrypting events in the Amazon EventBridge User Guide . > If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

For more information, see Encrypting archives in the Amazon EventBridge User Guide .

logConfigIResolvable | CfnEventBus.LogConfigPropertylog_configtyping.Union[IResolvable, LogConfigProperty]logConfigIResolvableLogConfigIResolvableLogConfiginterface{}#
The logging configuration settings for the event bus.

For more information, see Configuring logs for event buses in the EventBridge User Guide .

namestringnamestrnameStringNamestringName*stringrequired#
The name of the new event bus.
notes

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.

policyanypolicyAnypolicyObjectPolicyobjectPolicyinterface{}#
The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Tags to associate with the event bus.