Interface IBaseArchiveProps

The event archive base properties.

Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBaseArchiveProps
Syntax (vb)
Public Interface IBaseArchiveProps
Remarks

ExampleMetadata: infused

Examples
var bus = new EventBus(this, "bus", new EventBusProps {
    EventBusName = "MyCustomEventBus",
    Description = "MyCustomEventBus"
});

bus.Archive("MyArchive", new BaseArchiveProps {
    ArchiveName = "MyCustomEventBusArchive",
    Description = "MyCustomerEventBus Archive",
    EventPattern = new EventPattern {
        Account = new [] { Stack.Of(this).Account }
    },
    Retention = Duration.Days(365)
});

Synopsis

Properties

ArchiveName

The name of the archive.
Description

A description for the archive.
EventPattern

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

The number of days to retain events for.

Properties

ArchiveName

The name of the archive.

virtual string ArchiveName { get; }
Property Value

System.String

Remarks

Default: - Automatically generated

Description

A description for the archive.

virtual string Description { get; }
Property Value

System.String

Remarks

Default: - none

EventPattern

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

IEventPattern EventPattern { get; }
Property Value

IEventPattern

Retention

The number of days to retain events for.

virtual Duration Retention { get; }
Property Value

Duration

Remarks

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

Default: - Infinite