Skip to content

Configuration

CloudWatchLogsConfig holds every setting of a client. It is immutable after construction, validated when it is built (invalid values raise a CONFIG error) and its string/debug form redacts every credential. The AWS fields (region, credentials, profile, assume role, endpoint override, default log group and stream, account id, event size policy, existing SDK client) are listed under Functions → Service configuration; this page covers the settings shared by every Grow Codes SDK and how they map onto the AWS SDK client.

Common settings

Setting Default Environment variable
url — endpoint override none: the AWS SDK resolves https://logs.<region>.amazonaws.com GROW_AWS_CLOUDWATCH_LOGS_URL, AWS_ENDPOINT_URL_CLOUDWATCH_LOGS, AWS_ENDPOINT_URL
connectTimeout — connection setup 10 s GROW_AWS_CLOUDWATCH_LOGS_CONNECT_TIMEOUT
requestTimeout — per attempt (headers + body) 30 s GROW_AWS_CLOUDWATCH_LOGS_REQUEST_TIMEOUT
totalTimeout — whole call incl. retries and backoff 120 s GROW_AWS_CLOUDWATCH_LOGS_TOTAL_TIMEOUT
retry — retry policy (below); AWS SDK maxAttempts = maxRetries + 1 3 retries GROW_AWS_CLOUDWATCH_LOGS_MAX_RETRIES
tls.caCertPath / tls.caCertPem — extra CA none GROW_AWS_CLOUDWATCH_LOGS_CA_CERT (path)
tls.clientCertPath + tls.clientKeyPath — mutual TLS none GROW_AWS_CLOUDWATCH_LOGS_CLIENT_CERT, GROW_AWS_CLOUDWATCH_LOGS_CLIENT_KEY
tls.insecureSkipVerify — tests only, logs a warning once false GROW_AWS_CLOUDWATCH_LOGS_INSECURE_SKIP_VERIFY
proxy — proxy URL none (environment proxies are ignored) GROW_AWS_CLOUDWATCH_LOGS_PROXY
headers — extra request headers {} —
userAgentSuffix — appended to the User-Agent none —
hooks — request/response callbacks (Hooks) none —
logger — diagnostic logger (Hooks) silent —

Every request sends the AWS SDK User-Agent with the suffix grow-codes-aws-cloudwatch-logs/<version> (<language>) (not when you pass your own sdkClient). The per-attempt requestTimeout does not apply to live-tail streams (sessions last up to 3 hours).

From the environment

fromEnv resolves each setting with this precedence:

  1. the value passed in code (overrides),
  2. GROW_AWS_CLOUDWATCH_LOGS_<NAME>,
  3. the standard AWS and CloudWatch variables (see Functions), in their documented order,
  4. the default — for region and credentials the AWS SDK default chain (shared config, SSO, web identity, container and instance roles).

Parsing rules:

  • Durations accept integer milliseconds (1500) or Go-style units: 500ms, 10s, 2m, 1h, combinations such as 1m30s.
  • Booleans accept true/false, 1/0, yes/no, on/off (any case).
  • An empty variable counts as unset.
  • A present but invalid value raises a CONFIG error that names the variable, never its value.
import { CloudWatchLogsClient, CloudWatchLogsConfig } from "@grow-codes/aws-cloudwatch-logs";

// Environment only
const client = CloudWatchLogsClient.fromEnv();

// Environment with explicit overrides (explicit values win)
const config = CloudWatchLogsConfig.fromEnv({ requestTimeoutMs: 5_000 });

// Everything in code
const explicit = new CloudWatchLogsConfig({
  region: "eu-central-1",
  profile: "ops", // or accessKeyId + secretAccessKey, credentials, roleArn …
  connectTimeoutMs: 5_000,
  requestTimeoutMs: 15_000,
  totalTimeoutMs: 60_000,
  retry: { maxRetries: 5, initialBackoffMs: 200 },
  tls: { caCertPath: "/etc/ssl/internal-ca.pem" },
  proxy: "http://proxy.internal:3128",
  headers: { "x-team": "payments" },
  userAgentSuffix: "my-app/1.4",
});
const custom = new CloudWatchLogsClient(explicit);
console.log(String(explicit)); // credentials shown as [REDACTED]
use std::time::Duration;
use grow_aws_cloudwatch_logs::{CloudWatchLogsClient, CloudWatchLogsConfig, RetryPolicy};

// Environment only
let client = CloudWatchLogsClient::from_env()?;

// Environment with explicit overrides (explicit values win)
let config = CloudWatchLogsConfig::builder()
    .request_timeout(Duration::from_secs(5))
    .build_from_env()?;

// Everything in code
let explicit = CloudWatchLogsConfig::builder()
    .region("eu-central-1")
    .profile("ops") // or access_key_id + secret_access_key, credentials, role_arn …
    .connect_timeout(Duration::from_secs(5))
    .request_timeout(Duration::from_secs(15))
    .total_timeout(Duration::from_secs(60))
    .retry(RetryPolicy::default().with_max_retries(5))
    .ca_cert_path("/etc/ssl/internal-ca.pem")
    .proxy("http://proxy.internal:3128")
    .header("x-team", "payments")
    .user_agent_suffix("my-app/1.4")
    .build()?;
let custom = CloudWatchLogsClient::new(explicit)?;
println!("{:?}", custom.config()); // credentials shown as [REDACTED]
// Environment only
client, err := cloudwatchlogs.NewClientFromEnv()

// Everything in code: zero values mean "use the default"
cfg := cloudwatchlogs.Config{
    CommonConfig: cloudwatchlogs.CommonConfig{
        ConnectTimeout:  5 * time.Second,
        RequestTimeout:  15 * time.Second,
        TotalTimeout:    time.Minute,
        Retry:           &cloudwatchlogs.RetryPolicy{MaxRetries: 5, InitialBackoff: 200 * time.Millisecond},
        TLS:             cloudwatchlogs.TLSConfig{CACertPath: "/etc/ssl/internal-ca.pem"},
        Proxy:           "http://proxy.internal:3128",
        Headers:         map[string]string{"x-team": "payments"},
        UserAgentSuffix: "my-app/1.4",
    },
    Region:  "eu-central-1",
    Profile: "ops", // or AccessKeyID + SecretAccessKey, Credentials, RoleARN …
}
if err := cfg.Validate(); err != nil {
    log.Fatal(err) // errors.Is(err, cloudwatchlogs.ErrConfig)
}
custom, err := cloudwatchlogs.NewClient(cfg)

// Environment with explicit overrides (explicit values win; nil env = process environment)
merged, err := cloudwatchlogs.ConfigFromEnvWith(cloudwatchlogs.Config{
    CommonConfig: cloudwatchlogs.CommonConfig{RequestTimeout: 5 * time.Second},
}, nil)
fmt.Println(merged) // credentials shown as [REDACTED]
import os
from grow_aws_cloudwatch_logs import RetryPolicy, TlsConfig, CloudWatchLogsClient, CloudWatchLogsConfig

# Environment only
client = CloudWatchLogsClient.from_env()

# Environment with explicit overrides (explicit values win)
config = CloudWatchLogsConfig.from_env(request_timeout=5.0)

# Everything in code: durations are float seconds (datetime.timedelta also works)
explicit = CloudWatchLogsConfig(
    region="eu-central-1",
    profile="ops",  # or access_key_id + secret_access_key, credentials, role_arn …
    connect_timeout=5.0,
    request_timeout=15.0,
    total_timeout=60.0,
    retry=RetryPolicy(max_retries=5, initial_backoff=0.2),
    tls=TlsConfig(ca_cert_path="/etc/ssl/internal-ca.pem"),
    proxy="http://proxy.internal:3128",
    headers={"x-team": "payments"},
    user_agent_suffix="my-app/1.4",
)
custom = CloudWatchLogsClient(explicit)
print(repr(explicit))  # credentials shown as [REDACTED]
import java.time.Duration;
import codes.grow.packages.cloudwatchlogs.CloudWatchLogsClient;
import codes.grow.packages.cloudwatchlogs.CloudWatchLogsConfig;
import codes.grow.packages.cloudwatchlogs.core.RetryPolicy;

// Environment only
CloudWatchLogsClient client = CloudWatchLogsClient.fromEnv();

// Everything in code
CloudWatchLogsConfig config = CloudWatchLogsConfig.builder()
    .region("eu-central-1")
    .profile("ops") // or accessKeyId + secretAccessKey, credentials, roleArn …
    .connectTimeout(Duration.ofSeconds(5))
    .requestTimeout(Duration.ofSeconds(15))
    .totalTimeout(Duration.ofMinutes(1))
    .retry(RetryPolicy.builder().maxRetries(5).initialBackoff(Duration.ofMillis(200)).build())
    .proxy("http://proxy.internal:3128")
    .header("x-team", "payments")
    .userAgentSuffix("my-app/1.4")
    .build();
CloudWatchLogsClient custom = CloudWatchLogsClient.create(config);
System.out.println(config); // credentials shown as [REDACTED]

Retry policy

Field Default Meaning
maxRetries 3 retries after the first attempt (so up to 4 attempts)
initialBackoff 100 ms backoff cap of the first retry
maxBackoff 10 s cap of every backoff
multiplier 2 growth of the cap per retry
maxRetryAfter 60 s longest server-requested Retry-After the client waits for

Backoff for retry n (0-based) is full jitter: a random wait between 0 and min(maxBackoff, initialBackoff × multiplier^n).

Requests are retried on HTTP 429, 408, 502, 503, 504 and on network errors. Idempotent requests (GET HEAD OPTIONS PUT DELETE, or marked idempotent) are also retried on HTTP 500. Other requests (for example POST) are retried only on 429 and on connection errors that happened before the request was sent, never after an uncertain send.

On 429 and 503 the client honours Retry-After (seconds or HTTP date) and waits max(retryAfter, backoff). When that wait exceeds maxRetryAfter or the remaining totalTimeout, it stops at once with RATE_LIMITED/UNAVAILABLE and sets retryAfter on the error. Set maxRetries to 0 to turn retries off.

AWS SDK retries

Every CloudWatch Logs call is an HTTP POST made by the official AWS SDK, so the AWS SDK standard retry mode decides what is retried: throttling (ThrottlingException, LimitExceededException, HTTP 429), transient 5xx answers and network errors, with maxAttempts = maxRetries + 1 and the full-jitter backoff above. PutLogEvents is retried too; a response lost after the service stored a batch can duplicate those events (AWS no longer uses sequence tokens to reject duplicates). OperationAbortedException (a concurrent change to the same resource) is mapped to CONFLICT and marked retryable (except in Java, see Compatibility).

Timeouts and cancellation

  • connectTimeout bounds connection setup, requestTimeout each attempt, totalTimeout the whole call including backoff sleeps. An exhausted timeout raises TIMEOUT.
  • Cancellation is honoured during requests and backoff sleeps and raises CANCELLED: TypeScript { signal } (AbortSignal), Rust dropping the future, Go ctx, Python cancel= (CancelToken) or task cancellation, Java …Async futures (cancel(true)).

TLS and proxies

  • Add a private CA with tls.caCertPath (or the PEM text in tls.caCertPem).
  • Mutual TLS needs tls.clientCertPath and tls.clientKeyPath together.
  • tls.insecureSkipVerify disables certificate checks. Use it for local tests only; the client logs a warning once.
  • HTTP_PROXY/HTTPS_PROXY are ignored so that credentials never leave through an unexpected proxy. Set proxy (or GROW_AWS_CLOUDWATCH_LOGS_PROXY) to use one.