@grow-codes/aws-cloudwatch-logs - v0.1.1
    Preparing search index...

    Interface CloudWatchLogsConfigOptions

    Options accepted by CloudWatchLogsConfig (all optional).

    interface CloudWatchLogsConfigOptions {
        accessKeyId?: string;
        accountId?: string;
        autoCreate?: boolean;
        connectTimeoutMs?: number;
        credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
        externalId?: string;
        headers?: Record<string, string>;
        hooks?: Hooks;
        logger?: ClientLogger;
        logGroup?: string;
        logStream?: string;
        maxEventBytes?: number;
        oversizePolicy?: OversizePolicy;
        profile?: string;
        proxy?: string;
        region?: string;
        requestTimeoutMs?: number;
        retry?: RetryPolicyOptions | RetryPolicy;
        roleArn?: string;
        roleSessionName?: string;
        sdkClient?: CloudWatchLogsClient;
        secretAccessKey?: string | Secret;
        sessionToken?: string | Secret;
        tls?: TlsOptions;
        totalTimeoutMs?: number;
        url?: string;
        userAgentSuffix?: string;
    }

    Hierarchy (View Summary)

    Index
    accessKeyId?: string

    Access key id (env GROW_AWS_CLOUDWATCH_LOGS_ACCESS_KEY_ID > AWS_ACCESS_KEY_ID).

    accountId?: string

    AWS account id used to build log group ARNs for live tail (env …_ACCOUNT_ID); else looked up.

    autoCreate?: boolean

    putLogEvents creates a missing log stream and retries once (default true; env …_AUTO_CREATE).

    connectTimeoutMs?: number

    Connection setup timeout in ms (default 10 000).

    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

    An AWS SDK credentials object or provider (instead of the key fields or the default chain).

    externalId?: string

    STS external id (env GROW_AWS_CLOUDWATCH_LOGS_EXTERNAL_ID).

    headers?: Record<string, string>

    Extra request headers.

    hooks?: Hooks

    Request/response hooks.

    logger?: ClientLogger

    Diagnostic logger (silent by default).

    logGroup?: string

    Default log group of the LogClient and the query client (env …_LOG_GROUP > CLOUDWATCH_LOG_GROUP).

    logStream?: string

    Log stream of the LogClient (env …_LOG_STREAM > CLOUDWATCH_LOG_STREAM). Default <hostname>-<pid>-<random6>, created on first use.

    maxEventBytes?: number

    Per-event message limit in UTF-8 bytes (default 262 144, max 1 048 550; env …_MAX_EVENT_BYTES).

    oversizePolicy?: OversizePolicy

    Oversized events: truncate (default), drop or error (env …_OVERSIZE_POLICY).

    profile?: string

    Shared config profile (env GROW_AWS_CLOUDWATCH_LOGS_PROFILE > AWS_PROFILE).

    proxy?: string

    Proxy URL. Environment proxies (HTTPS_PROXY, …) are ignored unless set here.

    region?: string

    AWS region (env GROW_AWS_CLOUDWATCH_LOGS_REGION > AWS_REGION > AWS_DEFAULT_REGION).

    requestTimeoutMs?: number

    Per-attempt timeout in ms, headers + body (default 30 000).

    Retry policy or its options.

    roleArn?: string

    Role assumed with STS on top of the base credentials (env GROW_AWS_CLOUDWATCH_LOGS_ROLE_ARN).

    roleSessionName?: string

    STS session name (default grow-sdk, env GROW_AWS_CLOUDWATCH_LOGS_ROLE_SESSION_NAME).

    sdkClient?: CloudWatchLogsClient

    An existing AWS SDK CloudWatchLogsClient to use instead of building one. Mutually exclusive with the credential, region and endpoint fields; close() never destroys it and the Grow hooks, TLS, proxy, timeout and User-Agent settings do not apply to it.

    secretAccessKey?: string | Secret

    Secret access key (env GROW_AWS_CLOUDWATCH_LOGS_SECRET_ACCESS_KEY > AWS_SECRET_ACCESS_KEY).

    sessionToken?: string | Secret

    Session token (env GROW_AWS_CLOUDWATCH_LOGS_SESSION_TOKEN > AWS_SESSION_TOKEN).

    TLS settings.

    totalTimeoutMs?: number

    Whole-call timeout in ms including retries and backoff (default 120 000).

    url?: string

    Endpoint override (env GROW_AWS_CLOUDWATCH_LOGS_URL > AWS_ENDPOINT_URL_CLOUDWATCH_LOGS > AWS_ENDPOINT_URL). Unset: the AWS SDK resolves https://logs.<region>.amazonaws.com.

    userAgentSuffix?: string

    Appended after the standard User-Agent.