Class ObservabilityPipelineAmazonOpenSearchDestination

The amazon_opensearch destination writes logs to Amazon OpenSearch.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineAmazonOpenSearchDestination

Constructors

constructor

Properties

additionalProperties? auth? buffer? bulkIndex? dataStream? endpointUrlKey? id inputs type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional auth

auth?: ObservabilityPipelineAmazonOpenSearchDestinationAuth

Authentication settings for the Amazon OpenSearch destination. The strategy field determines whether basic or AWS-based authentication is used. When strategy is basic, use username_key and password_key to reference credentials stored in environment variables or secrets.

Optional buffer

buffer?: ObservabilityPipelineBufferOptions

Configuration for buffer settings on destination components.

Optional bulkIndex

bulkIndex?: string

The index to write logs to.

Optional dataStream

dataStream?: ObservabilityPipelineOpenSearchDestinationDataStream

Configuration options for writing to OpenSearch Data Streams instead of a fixed index.

Optional endpointUrlKey

endpointUrlKey?: string

Name of the environment variable or secret that holds the Amazon OpenSearch endpoint URL.

id

id: string

The unique identifier for this component.

inputs

inputs: string[]

A list of component IDs whose output is used as the input for this component.

type

type: ObservabilityPipelineAmazonOpenSearchDestinationType

The destination type. The value should always be amazon_opensearch.

Settings

Member Visibility

Theme

Generated using TypeDoc