Class ObservabilityPipelineAmazonS3Source

The amazon_s3 source ingests logs from an Amazon S3 bucket. It supports AWS authentication, TLS encryption, and configurable compression.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineAmazonS3Source

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).

Compression format for objects retrieved from the S3 bucket. Use auto to detect compression from the object's Content-Encoding header or file extension.

id: string

The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the input to downstream components).

region: string

AWS region where the S3 bucket resides.

Configuration for enabling TLS encryption between the pipeline component and external services.

The source type. Always amazon_s3.

urlKey?: string

Name of the environment variable or secret that holds the S3 bucket URL.

Generated using TypeDoc