software.amazon.awscdk.services.events

Interface BaseArchiveProps

All Known Subinterfaces:

ArchiveProps

All Known Implementing Classes:

ArchiveProps.Jsii$Proxy, BaseArchiveProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.337Z")
public interface BaseArchiveProps

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 java.lang.String	getArchiveName() The name of the archive.
default java.lang.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.

Method Detail

getEventPattern

EventPattern getEventPattern()

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

getArchiveName

default java.lang.String getArchiveName()

The name of the archive.

Default: - Automatically generated

getDescription

default java.lang.String getDescription()

A description for the archive.

Default: - none

getRetention

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

static BaseArchiveProps.Builder builder()

Returns:

a BaseArchiveProps.Builder of BaseArchiveProps