CreateEventStoreOptions
API reference for CreateEventStoreOptions
Interface: CreateEventStoreOptions
Section titled “Interface: CreateEventStoreOptions”Options for creating a new event store.
Properties
Section titled “Properties”description?
Section titled “description?”
optionaldescription:string
Optional description of the event store’s purpose or contents
name:
string
Display name of the event store (required) - should be between 3 and 64 characters long and can only contain lowercase letters, numbers, and hyphens
region?
Section titled “region?”
optionalregion:string
Optional cloud region where the event store should be created
settings?
Section titled “settings?”
optionalsettings:object
Optional configuration settings for the event store
maxStreamSizeBytes?
Section titled “maxStreamSizeBytes?”
optionalmaxStreamSizeBytes:number
Maximum size in bytes allowed per event stream
retentionPeriodDays?
Section titled “retentionPeriodDays?”
optionalretentionPeriodDays:number
Number of days to retain events before automatic deletion