Package software.amazon.awscdk.services.events

Interface BaseArchiveProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

ArchiveProps

All Known Implementing Classes:

ArchiveProps.Jsii$Proxy, BaseArchiveProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:31.889Z")
@Stability(Stable)
public interface BaseArchiveProps
extends software.amazon.jsii.JsiiSerializable

The event archive base properties.

Example:

 EventBus bus = EventBus.Builder.create(this, "bus")
         .eventBusName("MyCustomEventBus")
         .description("MyCustomEventBus")
         .build();
 bus.archive("MyArchive", BaseArchiveProps.builder()
         .archiveName("MyCustomEventBusArchive")
         .description("MyCustomerEventBus Archive")
         .eventPattern(EventPattern.builder()
                 .account(List.of(Stack.of(this).getAccount()))
                 .build())
         .retention(Duration.days(365))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	BaseArchiveProps.Builder	A builder for BaseArchiveProps
static final class	BaseArchiveProps.Jsii$Proxy	An implementation for BaseArchiveProps

Method Summary

Modifier and Type	Method	Description
static BaseArchiveProps.Builder	builder()
default String	getArchiveName()	The name of the archive.
default String	getDescription()	A description for the archive.
EventPattern	getEventPattern()	An event pattern to use to filter events sent to the archive.
default IKey	getKmsKey()	The customer managed key that encrypts this archive.
default Duration	getRetention()	The number of days to retain events for.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventPattern

@Stability(Stable)
@NotNull
EventPattern getEventPattern()

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

getArchiveName

@Stability(Stable)
@Nullable
default String getArchiveName()

The name of the archive.

Default: - Automatically generated

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the archive.

Default: - none

getKmsKey

@Stability(Stable)
@Nullable
default IKey getKmsKey()

The customer managed key that encrypts this archive.

Default: - Use an AWS managed key

getRetention

@Stability(Stable)
@Nullable
default Duration getRetention()

The number of days to retain events for.

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

Default: - Infinite

builder

@Stability(Stable)
static BaseArchiveProps.Builder builder()

Returns:

a BaseArchiveProps.Builder of BaseArchiveProps