aws-cdk-lib.aws_events.BaseArchiveProps

BaseArchiveProps Struct

The event archive base properties.

Source

aws-events/lib/archive.ts

Type last changed

v2.214.0 · 2 Sep 2025

Example

const bus = new events.EventBus(this, 'bus', {
  eventBusName: 'MyCustomEventBus',
  description: 'MyCustomEventBus',
});

bus.archive('MyArchive', {
  archiveName: 'MyCustomEventBusArchive',
  description: 'MyCustomerEventBus Archive',
  eventPattern: {
    account: [Stack.of(this).account],
  },
  retention: Duration.days(365),
});

Properties

archiveNamestringarchive_namestrarchiveNameStringArchiveNamestringArchiveName*string= Automatically generated#

The name of the archive.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= none#

A description for the archive.

eventPatternEventPatternevent_patternEventPatterneventPatternEventPatternEventPatternEventPatternEventPatternEventPatternrequired#

An event pattern to use to filter events sent to the archive.

kmsKeyIKeykms_keyIKeykmsKeyIKeyKmsKeyIKeyKmsKeyIKey= Use an AWS managed key#

The customer managed key that encrypts this archive.

retentionDurationretentionDurationretentionDurationRetentionDurationRetentionDuration= Infinite#

The number of days to retain events for.

Default value is 0. If set to 0, events are retained indefinitely.