Skip to content
v2.274.0

CfnEventBusProps Struct ​

Properties for defining a CfnEventBus.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventsv2 as eventsv2 } from 'aws-cdk-lib';
const cfnEventBusProps: eventsv2.CfnEventBusProps = {
  name: 'name',

  // the properties below are optional
  description: 'description',
  encryptionConfiguration: {
    kmsKeyIdentifier: 'kmsKeyIdentifier',
  },
  storageConfiguration: {
    retentionPeriodInDays: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the event bus.

Control characters and Unicode line separators are not allowed.

encryptionConfigurationoptionalIResolvable | CfnEventBus.EncryptionConfigurationPropertyencryption_configurationoptionaltyping.Union[IResolvable, EncryptionConfigurationProperty]encryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalinterface{}#
Encryption configuration for an event bus.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the event bus.

The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

storageConfigurationoptionalIResolvable | CfnEventBus.StorageConfigurationPropertystorage_configurationoptionaltyping.Union[IResolvable, StorageConfigurationProperty]storageConfigurationoptionalIResolvableStorageConfigurationoptionalIResolvableStorageConfigurationoptionalinterface{}#
Storage (retention) configuration for the event bus.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags assigned to the event bus.