Configure staRburst options

Reads and updates the persisted staRburst configuration. Call with no arguments to leave settings unchanged (it still returns the current config invisibly); pass one or more of the arguments below to update them.

Usage

starburst_config(
  max_hourly_cost = NULL,
  cost_alert_threshold = NULL,
  auto_cleanup_s3 = NULL,
  ...
)

Arguments

max_hourly_cost

Maximum estimated **hourly** cost (USD/hour) for a job. Jobs whose estimated hourly rate exceeds this error before launching. This is a rate limit, not a total-job-cost cap. NULL leaves it unchanged.

cost_alert_threshold

Estimated **hourly** cost (USD/hour) at which a warning is emitted. NULL leaves it unchanged.

auto_cleanup_s3

Logical; automatically delete a job's S3 task/result objects after completion. NULL leaves it unchanged.

...

Additional user-settable keys merged into the config. Recognized keys:

use_public_base

Logical; pull the public base image instead of building a private one (see starburst_setup).

ecr_image_ttl_days

Integer; lifecycle age at which cached ECR images are expired.

Value

Invisibly returns the updated configuration list.

Details

Other keys in the stored config are **infrastructure-managed** — written by starburst_setup/starburst_setup_ec2 and not intended to be set by hand: region, bucket, cluster, ecr_repository, aws_account_id, execution_role_arn, task_role_arn, subnets, and security_groups. Use starburst_status to inspect the effective configuration read-only.

See also

starburst_status to view config without changing it; starburst_setup for initial provisioning.

Examples

# \donttest{
if (starburst_is_configured()) {
  # Update cost guardrails (both are hourly rates, USD/hour)
  starburst_config(
    max_hourly_cost = 10,
    cost_alert_threshold = 5
  )

  # Read the current config without changing anything
  cfg <- starburst_config()
}
# }