interface BaseArchiveProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Events.BaseArchiveProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsevents#BaseArchiveProps |
![]() | software.amazon.awscdk.services.events.BaseArchiveProps |
![]() | aws_cdk.aws_events.BaseArchiveProps |
![]() | aws-cdk-lib » aws_events » BaseArchiveProps |
The event archive base properties.
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
Name | Type | Description |
---|---|---|
event | Event | An event pattern to use to filter events sent to the archive. |
archive | string | The name of the archive. |
description? | string | A description for the archive. |
retention? | Duration | The number of days to retain events for. |
eventPattern
Type:
Event
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.