Class ArchiveProps

The event archive properties.

Inheritance

object

ArchiveProps

Implements

IArchiveProps

IBaseArchiveProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ArchiveProps : IArchiveProps, IBaseArchiveProps

Syntax (vb)

Public Class ArchiveProps Implements IArchiveProps, IBaseArchiveProps

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.KMS;
            using Amazon.CDK.AWS.Events;

            IKey kmsKey;


            var stack = new Stack();

            var eventBus = new EventBus(stack, "Bus");

            var archive = new Archive(stack, "Archive", new ArchiveProps {
                KmsKey = kmsKey,
                SourceEventBus = eventBus,
                EventPattern = new EventPattern {
                    Source = new [] { "aws.ec2" }
                }
            });

Synopsis

Constructors

ArchiveProps()

The event archive properties.

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.
KmsKey	The customer managed key that encrypts this archive.
Retention	The number of days to retain events for.
SourceEventBus	The event source associated with the archive.

Constructors

ArchiveProps()

The event archive properties.

public ArchiveProps()

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.KMS;
            using Amazon.CDK.AWS.Events;

            IKey kmsKey;


            var stack = new Stack();

            var eventBus = new EventBus(stack, "Bus");

            var archive = new Archive(stack, "Archive", new ArchiveProps {
                KmsKey = kmsKey,
                SourceEventBus = eventBus,
                EventPattern = new EventPattern {
                    Source = new [] { "aws.ec2" }
                }
            });

Properties

ArchiveName

The name of the archive.

public string? ArchiveName { get; set; }

Property Value

string

Remarks

Default: - Automatically generated

Description

A description for the archive.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - none

EventPattern

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

public IEventPattern EventPattern { get; set; }

Property Value

IEventPattern

Remarks

ExampleMetadata: infused

KmsKey

The customer managed key that encrypts this archive.

public IKey? KmsKey { get; set; }

Property Value

IKey

Remarks

Default: - Use an AWS managed key

Retention

The number of days to retain events for.

public Duration? Retention { get; set; }

Property Value

Duration

Remarks

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

Default: - Infinite

SourceEventBus

The event source associated with the archive.

public IEventBusRef SourceEventBus { get; set; }

Property Value

IEventBusRef

Remarks

ExampleMetadata: infused

Implements

IArchiveProps

IBaseArchiveProps