aws-cdk-lib.aws_events.BaseArchiveProps

interface BaseArchiveProps

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

The event archive base properties.

Example

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

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

Properties

NameTypeDescription
eventPatternEventPatternAn event pattern to use to filter events sent to the archive.
archiveName?stringThe name of the archive.
description?stringA description for the archive.
retention?DurationThe number of days to retain events for.

eventPattern

Type: EventPattern

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


archiveName?

Type: string (optional, default: Automatically generated)

The name of the archive.


description?

Type: string (optional, default: none)

A description for the archive.


retention?

Type: Duration (optional, default: Infinite)

The number of days to retain events for.

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