@logtape/cloudwatch-logs/dist/types.d.cts

AWS CloudWatch Logs sink for LogTape

import { CloudWatchLogsClient } from "@aws-sdk/client-cloudwatch-logs";
import { TextFormatter } from "@logtape/logtape";

//#region types.d.ts

/**
 * Options for configuring the CloudWatch Logs sink.
 * @since 1.0.0
 */
interface CloudWatchLogsSinkOptions {
  /**
   * An existing CloudWatch Logs client instance.
   * If provided, the client will be used directly and other connection
   * options (region, credentials) will be ignored.
   */
  readonly client?: CloudWatchLogsClient;
  /**
   * The name of the log group to send log events to.
   */
  readonly logGroupName: string;
  /**
   * The name of the log stream within the log group.
   */
  readonly logStreamName: string;
  /**
   * The AWS region to use when creating a new client.
   * Ignored if `client` is provided.
   * @default "us-east-1"
   */
  readonly region?: string;
  /**
   * AWS credentials to use when creating a new client.
   * Ignored if `client` is provided.
   * If not provided, the AWS SDK will use default credential resolution.
   */
  readonly credentials?: {
    readonly accessKeyId: string;
    readonly secretAccessKey: string;
    readonly sessionToken?: string;
  };
  /**
   * Maximum number of log events to batch before sending to CloudWatch.
   * Must be between 1 and 10,000.
   * @default 1000
   */
  readonly batchSize?: number;
  /**
   * Maximum time in milliseconds to wait before flushing buffered log events.
   * Set to 0 or negative to disable time-based flushing.
   * @default 1000
   */
  readonly flushInterval?: number;
  /**
   * Maximum number of retry attempts for failed requests.
   * @default 3
   */
  readonly maxRetries?: number;
  /**
   * Initial delay in milliseconds for exponential backoff retry strategy.
   * @default 100
   */
  readonly retryDelay?: number;
  /**
   * Text formatter to use for formatting log records before sending to CloudWatch Logs.
   * If not provided, defaults to a simple text formatter.
   * Use `jsonLinesFormatter()` from "@logtape/logtape" for JSON structured logging
   * to enable powerful CloudWatch Logs Insights querying capabilities.
   * @since 1.0.0
   */
  readonly formatter?: TextFormatter;
}
//# sourceMappingURL=types.d.ts.map
//#endregion
export { CloudWatchLogsSinkOptions };
//# sourceMappingURL=types.d.cts.map