interface TelemetryPipelineConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.ObservabilityAdmin.CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsobservabilityadmin#CfnTelemetryPipelines_TelemetryPipelineConfigurationProperty |
 Java | software.amazon.awscdk.services.observabilityadmin.CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty |
 Python | aws_cdk.aws_observabilityadmin.CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty |
 TypeScript | aws-cdk-lib » aws_observabilityadmin » CfnTelemetryPipelines » TelemetryPipelineConfigurationProperty |
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 AWS Secrets Manager integration for credential management.
For more details on each configuration section see CloudWatch pipelines User Guide . Additional comprehensive configuration examples can be found in the CreateTelemetryPipeline API docs .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_observabilityadmin as observabilityadmin } from 'aws-cdk-lib';
const telemetryPipelineConfigurationProperty: observabilityadmin.CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty = {
body: 'body',
};
Properties
| Name | Type | Description |
|---|---|---|
| body | string | The pipeline configuration body that defines the data processing rules and transformations. |
body
Type:
string
The pipeline configuration body that defines the data processing rules and transformations.