One Observability Workshop v3.0.0

One Observability Workshop / constructs/opensearch-pipeline / OpenSearchPipelineProperties

Interface: OpenSearchPipelineProperties¶

Defined in: constructs/opensearch-pipeline.ts:44

Properties for configuring OpenSearchPipeline construct OpenSearchPipelineProperties

Properties¶

pipelineName?¶

optional pipelineName: string

Defined in: constructs/opensearch-pipeline.ts:49

Name of the OpenSearch Ingestion pipeline

Default¶

'pet-logs-pipeline'

openSearchCollection¶

openSearchCollection: OpenSearchCollection | { collectionArn: string; collectionEndpoint: string; }

Defined in: constructs/opensearch-pipeline.ts:54

OpenSearch collection to send logs to

bufferOptions?¶

optional bufferOptions: object

Defined in: constructs/opensearch-pipeline.ts:65

Log buffer configuration

flushInterval?¶

optional flushInterval: number

batchSize?¶

optional batchSize: number

Default¶

{ flushInterval: 60, batchSize: 1000 }

indexTemplate?¶

optional indexTemplate: string

Defined in: constructs/opensearch-pipeline.ts:74

Index template for log organization

Default¶

'logs-{yyyy.MM.dd}'

capacityLimits?¶

optional capacityLimits: object

Defined in: constructs/opensearch-pipeline.ts:80

Minimum and maximum pipeline capacity units

min?¶

optional min: number

max?¶

optional max: number

Default¶

{ min: 1, max: 4 }