Package software.amazon.awscdk.services.observabilityadmin

Interface CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTelemetryPipelines

@Stability(Stable)
public static interface CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.observabilityadmin.*;
 TelemetryPipelineConfigurationProperty telemetryPipelineConfigurationProperty = TelemetryPipelineConfigurationProperty.builder()
         .body("body")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty.Builder	A builder for CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty
static final class	CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty.Jsii$Proxy	An implementation for CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty.Builder	builder()
String	getBody()	The pipeline configuration body that defines the data processing rules and transformations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBody

@Stability(Stable)
@NotNull
String getBody()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration-body

builder

@Stability(Stable)
static CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty.Builder builder()

Returns:

a CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty.Builder of CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty