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

    Class CloudWatchLogsConfig

    Immutable configuration of CloudWatchLogsClient.

    Implements

    Index
    accessKeyId?: string

    Access key id.

    accountId?: string

    Account id for live-tail ARNs.

    autoCreate: boolean

    Create missing log streams in putLogEvents.

    connectTimeoutMs: number
    credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider

    Explicit SDK credentials.

    endpoint?: string

    Explicit endpoint override passed to the AWS SDK (undefined = the SDK resolves it).

    externalId?: string

    STS external id.

    headers: Readonly<Record<string, string>>
    hooks?: Hooks
    logger?: ClientLogger
    logGroup?: string

    Default log group.

    logStream: string

    Log stream of the LogClient.

    maxEventBytes: number

    Per-event message limit in UTF-8 bytes.

    oversizePolicy: OversizePolicy

    Policy for oversized events.

    profile?: string

    Shared config profile.

    proxy?: string
    region?: string

    AWS region (undefined = SDK chain: env, shared config).

    requestTimeoutMs: number
    roleArn?: string

    Role assumed with STS.

    roleSessionName: string

    STS session name.

    sdkClient?: CloudWatchLogsClient

    Caller-supplied AWS SDK client.

    secretAccessKey?: Secret

    Secret access key.

    sessionToken?: Secret

    Session token.

    tls: Readonly<TlsOptions>
    totalTimeoutMs: number
    url: string

    Effective endpoint: endpoint when set, otherwise the public AWS endpoint of region (us-east-1 when the region is left to the SDK). Informational.

    userAgentSuffix?: string
    ENV_PREFIX: "GROW_AWS_CLOUDWATCH_LOGS_"

    Prefix of every environment variable.

    • Credential values to redact from error messages and logs.

      Returns string[]

    • Debug form with every credential redacted.

      Returns Record<string, unknown>

    • Returns a string representation of an object.

      Returns string