L2 Construct

Archive

Define an EventBridge Archive.

Import

import { Archive } from 'aws-cdk-lib/aws-events';

Or use the module namespace:

import * as events from 'aws-cdk-lib/aws-events';
// events.Archive

Configuration passed to the constructor as ArchiveProps.

sourceEventBusRequired

IEventBusRef

The event source associated with the archive.

5 properties inherited from BaseArchiveProps

eventPatternRequiredinherited from BaseArchiveProps

EventPattern

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

archiveNameOptionalinherited from BaseArchiveProps

string

The name of the archive.

Default: - Automatically generated

descriptionOptionalinherited from BaseArchiveProps

string

A description for the archive.

Default: - none

kmsKeyOptionalinherited from BaseArchiveProps

IKey

The customer managed key that encrypts this archive.

Default: - Use an AWS managed key

retentionOptionalinherited from BaseArchiveProps

Duration

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely.

Default: - Infinite

Everything you need to know about Amazon EventBridge on one page. HD quality, print-friendly.

LevelL2 (Higher-level)

Moduleaws-events

Properties6