Class: Aws::ObservabilityAdmin::Types::TelemetryPipelineConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-observabilityadmin/types.rb

Overview

Defines the configuration for a pipeline, including how data flows from sources through processors to destinations. The configuration is specified in YAML format and must include a valid pipeline definition with required source and sink components. This pipeline enables end-to-end telemetry data collection, transformation, and delivery while supporting optional processing steps and extensions for enhanced functionality.

The primary pipeline configuration section are:

  • Source: Defines where log data originates from (S3 buckets, CloudWatch Logs, third-party APIs). Each pipeline must have exactly one source.

  • **Processors (optional):** Transform, parse, and enrich log data as it flows through the pipeline. Processors are applied sequentially in the order they are defined.

  • Sink: Defines the destination where processed log data is sent. Each pipeline must have exactly one sink.

  • **Extensions (optional):** Provide additional functionality such as Amazon Web Services Secrets Manager integration for credential management.

For more details on each configuration section see [CloudWatch pipelines User Guide][1]. Additional comprehensive configuration examples can be found in the [CreateTelemetryPipeline API docs][2].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-pipelines.html [2]: docs.aws.amazon.com/cloudwatch/latest/observabilityadmin/API_CreateTelemetryPipeline.html#API_CreateTelemetryPipeline_Examples

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The pipeline configuration body that defines the data processing rules and transformations.

Returns:

  • (String)


2122
2123
2124
2125
2126
# File 'lib/aws-sdk-observabilityadmin/types.rb', line 2122

class TelemetryPipelineConfiguration < Struct.new(
  :body)
  SENSITIVE = []
  include Aws::Structure
end