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.101.0 (build b95fe5d)", date="2024-07-12T19:34:02.169Z") @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")
         .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());
 
  • 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

    • 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