Table of Contents

Class CreateArchiveRequest

Namespace
Amazon.EventBridge.Model
Assembly
AWSSDK.EventBridge.dll

Container for the parameters to the CreateArchive operation. Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

note

Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

  • You call CreateArchive on an event bus set to use a customer managed key for encryption.

  • You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

  • You call UpdatedEventBus to set a customer managed key on an event bus with an archives or schema discovery enabled.

To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide. 

public class CreateArchiveRequest : AmazonEventBridgeRequest
Inheritance
CreateArchiveRequest

Constructors

CreateArchiveRequest() 

public CreateArchiveRequest()

Properties

ArchiveName

Gets and sets the property ArchiveName.

The name for the archive to create. 

public string ArchiveName { get; set; }

Property Value

string

Description

Gets and sets the property Description.

A description for the archive. 

public string Description { get; set; }

Property Value

string

EventPattern

Gets and sets the property EventPattern.

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

public string EventPattern { get; set; }

Property Value

string

EventSourceArn

Gets and sets the property EventSourceArn.

The ARN of the event bus that sends events to the archive. 

public string EventSourceArn { get; set; }

Property Value

string

RetentionDays

Gets and sets the property RetentionDays.

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely 

public int RetentionDays { get; set; }

Property Value

int