Class ObservabilityPipelineAmazonS3GenericDestination

The amazon_s3_generic destination sends your logs to an Amazon S3 bucket.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineAmazonS3GenericDestination

Constructors

constructor

Properties

additionalProperties? auth? batchSettings? bucket compression encoding id inputs keyPrefix? region storageClass type

Constructors

constructor

Properties

Optional additionalProperties

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

Optional auth

auth?: ObservabilityPipelineAwsAuth

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).

Optional batchSettings

batchSettings?: ObservabilityPipelineAmazonS3GenericBatchSettings

Event batching settings

bucket

bucket: string

S3 bucket name.

compression

compression: ObservabilityPipelineAmazonS3GenericCompression

Compression algorithm applied to encoded logs.

encoding

encoding: ObservabilityPipelineAmazonS3GenericEncoding

Encoding format for the destination.

id

id: string

Unique identifier for the destination component.

inputs

inputs: string[]

A list of component IDs whose output is used as the input for this component.

Optional keyPrefix

keyPrefix?: string

Optional prefix for object keys.

region

region: string

AWS region of the S3 bucket.

storageClass

storageClass: ObservabilityPipelineAmazonS3DestinationStorageClass

S3 storage class.

type

type: ObservabilityPipelineAmazonS3GenericDestinationType

The destination type. Always amazon_s3_generic.

Settings

Member Visibility

Theme

Generated using TypeDoc