Synopsis
cloudburn discover [flags]
cloudburn discover <subcommand> [flags]
Description
Queries live AWS resources via AWS Resource Explorer, enriches them with service-specific data via hydrators, and evaluates cost optimization rules against the results.
Resource Explorer must be set up before running discovery. Use cloudburn discover init to create the required indexes.
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
--config | string | auto-discovery | Path to a .cloudburn.yml config file. |
--enabled-rules | string | all rules | Comma-separated rule IDs to include. |
--disabled-rules | string | none | Comma-separated rule IDs to exclude. |
--service | string | all services | Comma-separated services to scan (e.g. ec2,ebs). |
--region | string | current region | AWS region to scan. Pass all to scan all indexed regions (requires aggregator). |
--exit-code | boolean | false | Exit with code 1 when findings exist. |
--format | "table" or "json" | "table" | Output format. |
Subcommands
| Subcommand | Description |
|---|---|
init | Set up AWS Resource Explorer indexes in your account |
status | Show the current Resource Explorer status |
list-enabled-regions | List regions that have been indexed |
supported-resource-types | List resource types CloudBurn can discover |
init
Synopsis
cloudburn discover init [flags]
Description
Sets up AWS Resource Explorer indexes across all enabled regions and promotes the index in the specified region to the aggregator. By default, the current active region (from your AWS profile or AWS_REGION environment variable) becomes the aggregator. If indexes already exist, they are reused.
See the Resource Explorer Setup guide for a detailed walkthrough.
Flags
| Flag | Type | Default | Description |
|---|---|---|---|
--region | string | current region | Region to use as the aggregator |
Example
cloudburn discover init
cloudburn discover init --region eu-west-1
status
Synopsis
cloudburn discover status
Description
Displays the current state of Resource Explorer in your account, including which regions are indexed and whether an aggregator is configured.
Output format
Resource Explorer status: ACTIVE
Indexed regions: us-east-1, us-west-2
Aggregator: us-east-1
Example
cloudburn discover status
list-enabled-regions
Synopsis
cloudburn discover list-enabled-regions
Description
Lists all regions that have a Resource Explorer index. Only regions listed here can be targeted with --region <region>.
Example
cloudburn discover list-enabled-regions
supported-resource-types
Synopsis
cloudburn discover supported-resource-types
Description
Lists all AWS resource types that CloudBurn's discovery mode supports. Use this to understand which services and resource types are covered before running a scan.
Example
cloudburn discover supported-resource-types
Exit codes
| Code | Meaning |
|---|---|
0 | Scan completed with no findings, or --exit-code not passed |
1 | Findings exist and --exit-code was passed |
2 | Runtime error (credentials missing, Resource Explorer not set up, etc.) |
Examples
Run discovery in the current region:
cloudburn discover
Scan all indexed regions:
cloudburn discover --region all
Scan a specific region with JSON output:
cloudburn --format json discover --region us-west-2
Filter to EC2 and EBS rules only:
cloudburn discover --service ec2,ebs
What's next
| Quickstart: Discover AWS Resources | Step-by-step first discovery scan |
| Exit Codes | Use exit codes in CI/CD pipelines |
| Rules | Rules evaluated during discovery |