Class TelemetryPipelineConfiguration

java.lang.Object
software.amazon.awssdk.services.observabilityadmin.model.TelemetryPipelineConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TelemetryPipelineConfiguration.Builder,TelemetryPipelineConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class TelemetryPipelineConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TelemetryPipelineConfiguration.Builder,TelemetryPipelineConfiguration>

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. Additional comprehensive configuration examples can be found in the CreateTelemetryPipeline API docs.

See Also:

  • Method Details

    • body

      public final String body()

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

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

    • toBuilder

      public TelemetryPipelineConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TelemetryPipelineConfiguration.Builder,TelemetryPipelineConfiguration>
      Returns:
      a builder for type T

    • builder

      public static TelemetryPipelineConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TelemetryPipelineConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.