Class: DatadogAPIClient::V2::ObservabilityPipelineAmazonOpenSearchDestination

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb

Overview

The amazon_opensearch destination writes logs to Amazon OpenSearch.

Supported pipeline types: logs

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



52
53
54
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb', line 52

def additional_properties
  @additional_properties
end

#auth ⇒ Object

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.



29
30
31
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb', line 29

def auth
  @auth
end

#buffer ⇒ Object

Configuration for buffer settings on destination components.



32
33
34
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb', line 32

def buffer
  @buffer
end

#bulk_index ⇒ Object

The index to write logs to.



35
36
37
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb', line 35

def bulk_index
  @bulk_index
end

#data_stream ⇒ Object

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



38
39
40
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb', line 38

def data_stream
  @data_stream
end

#endpoint_url_key ⇒ Object

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



41
42
43
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb', line 41

def endpoint_url_key
  @endpoint_url_key
end

#id ⇒ Object

The unique identifier for this component.



44
45
46
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb', line 44

def id
  @id
end

#inputs ⇒ Object

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



47
48
49
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb', line 47

def inputs
  @inputs
end

#type ⇒ Object

The destination type. The value should always be amazon_opensearch.



50
51
52
 
# File 'lib/datadog_api_client/v2/models/observability_pipeline_amazon_open_search_destination.rb', line 50

def type
  @type
end