Class: AWSCDK::ObservabilityAdmin::CfnTelemetryPipelines::TelemetryPipelineConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ObservabilityAdmin::CfnTelemetryPipelines::TelemetryPipelineConfigurationProperty

Defined in:

observability_admin/cfn_telemetry_pipelines.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 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 .

See Also:

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

Instance Attribute Summary

• #body ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(body:) ⇒ TelemetryPipelineConfigurationProperty constructor

  A new instance of TelemetryPipelineConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(body:) ⇒ TelemetryPipelineConfigurationProperty

Returns a new instance of TelemetryPipelineConfigurationProperty.

Parameters:

• body (String) —

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

# File 'observability_admin/cfn_telemetry_pipelines.rb', line 591

def initialize(body:)
  @body = body
  Jsii::Type.check_type(@body, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "body")
end

Instance Attribute Details

#body ⇒ String (readonly)

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

Returns:

• (String)

See Also:

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

# File 'observability_admin/cfn_telemetry_pipelines.rb', line 600

def body
  @body
end

Class Method Details

.jsii_properties ⇒ Object

# File 'observability_admin/cfn_telemetry_pipelines.rb', line 602

def self.jsii_properties
  {
    :body => "body",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'observability_admin/cfn_telemetry_pipelines.rb', line 608

def to_jsii
  result = {}
  result.merge!({
    "body" => @body,
  })
  result.compact
end