Class ArchiveProps
The event archive properties.
Inheritance
System.Object
ArchiveProps
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ArchiveProps : Object, IArchiveProps, IBaseArchiveProps
Syntax (vb)
Public Class ArchiveProps
Inherits Object
Implements IArchiveProps, IBaseArchiveProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Events;
var detail;
EventBus eventBus;
var archiveProps = new ArchiveProps {
EventPattern = new EventPattern {
Account = new [] { "account" },
Detail = new Dictionary<string, object> {
{ "detailKey", detail }
},
DetailType = new [] { "detailType" },
Id = new [] { "id" },
Region = new [] { "region" },
Resources = new [] { "resources" },
Source = new [] { "source" },
Time = new [] { "time" },
Version = new [] { "version" }
},
SourceEventBus = eventBus,
// the properties below are optional
ArchiveName = "archiveName",
Description = "description",
Retention = Duration.Minutes(30)
};
Synopsis
Constructors
ArchiveProps() |
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. |
SourceEventBus | The event source associated with the archive. |
Constructors
ArchiveProps()
public ArchiveProps()
Properties
ArchiveName
The name of the archive.
public string ArchiveName { get; set; }
Property Value
System.String
Remarks
Default: - Automatically generated
Description
A description for the archive.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: - none
EventPattern
An event pattern to use to filter events sent to the archive.
public IEventPattern EventPattern { get; set; }
Property Value
Retention
The number of days to retain events for.
public Duration Retention { get; set; }
Property Value
Remarks
Default value is 0. If set to 0, events are retained indefinitely.
Default: - Infinite
SourceEventBus
The event source associated with the archive.
public IEventBus SourceEventBus { get; set; }
Property Value