Package software.amazon.awscdk.services.events

Class Archive.Builder

java.lang.Object
software.amazon.awscdk.services.events.Archive.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Archive>
Enclosing class:
Archive
@Stability(Stable) public static final class Archive.Builder extends Object implements software.amazon.jsii.Builder<Archive>
A fluent builder for Archive.

  • Method Details

    • create

      @Stability(Stable) public static Archive.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Archive.Builder.

    • eventPattern

      @Stability(Stable) public Archive.Builder eventPattern(EventPattern eventPattern)
      An event pattern to use to filter events sent to the archive.

      Parameters:
      eventPattern - An event pattern to use to filter events sent to the archive. This parameter is required.
      Returns:
      this

    • archiveName

      @Stability(Stable) public Archive.Builder archiveName(String archiveName)
      The name of the archive.

      Default: - Automatically generated

      Parameters:
      archiveName - The name of the archive. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public Archive.Builder description(String description)
      A description for the archive.

      Default: - none

      Parameters:
      description - A description for the archive. This parameter is required.
      Returns:
      this

    • retention

      @Stability(Stable) public Archive.Builder retention(Duration retention)
      The number of days to retain events for.

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

      Default: - Infinite

      Parameters:
      retention - The number of days to retain events for. This parameter is required.
      Returns:
      this

    • sourceEventBus

      @Stability(Stable) public Archive.Builder sourceEventBus(IEventBus sourceEventBus)
      The event source associated with the archive.

      Parameters:
      sourceEventBus - The event source associated with the archive. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public Archive build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Archive>
      Returns:
      a newly built instance of Archive.