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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.251Z")
 @Stability(value=Stable)
public interface BaseArchiveProps
extends software.amazon.jsii.JsiiSerializable

The event archive base properties.

Example:

 EventBus bus = EventBus.Builder.create(this, "bus")
         .eventBusName("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 and Description
static class	BaseArchiveProps.Builder A builder for BaseArchiveProps
static class	BaseArchiveProps.Jsii$Proxy An implementation for BaseArchiveProps

Method Summary

Modifier and Type	Method and 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 Duration	getRetention() The number of days to retain events for.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEventPattern

@Stability(value=Stable)
 @NotNull
EventPattern getEventPattern()

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

getArchiveName

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

The name of the archive.

Default: - Automatically generated

getDescription

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

A description for the archive.

Default: - none

getRetention

@Stability(value=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(value=Stable)
static BaseArchiveProps.Builder builder()

Returns:

a BaseArchiveProps.Builder of BaseArchiveProps