> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vantage.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# vantage_cost_report (Resource)

> Terraform resource reference for vantage_cost_report (Resource). Auto-generated from the vantage-sh/terraform-provider-vantage repository.

<Note>
  This page is auto-generated based on the official [Terraform documentation](https://registry.terraform.io/providers/vantage-sh/vantage/latest/docs).
</Note>

## Overview

Use this resource with the [Vantage Terraform provider](/terraform). For installation and authentication, see the [Terraform provider quickstart](/terraform#quickstart). The schema below is generated directly from the provider source.

Manages a CostReport.

## Example Usage

```terraform theme={null}
resource "vantage_cost_report" "demo_report" {
  title               = "Demo Report"
  folder_token        = "fldr_3555785cd0409118"
  filter              = "costs.provider = 'aws'"
  saved_filter_tokens = ["svd_fltr_e844a2ccace05933", "svd_fltr_1b4b80a380ef4ba2"]
  workspace_token = "wrkspc_47c3254c790e9351"
  chart_type = "line" # Allowed: area, line, pie, bar, multi-bar
  date_bin = "day"    # Allowed: cumulative, day, week, month, quarter

  settings = {
    include_credits      = true
    include_refunds      = true
    include_discounts    = true
    include_tax          = true
    amortize             = false
    unallocated          = false
    aggregate_by         = "cost" # Allowed: cost, usage
    show_previous_period = false
  }

  # optionally, use folder_token instead of workspace_token
  # folder_token = "fldr_47c3254c790e9351"
}
```

## Schema

### Required

* `title` (String) Title of the Cost Report

### Optional

* `chart_settings` (Attributes) Chart settings for the Cost Report. (see [below for nested schema](#nestedatt--chart_settings))
* `chart_type` (String) Chart type to apply to the Cost Report.
* `date_bin` (String) Date bin to apply to the Cost Report.
* `date_interval` (String) Date interval to apply to the Cost Report.
* `end_date` (String) End date to apply to the Cost Report.
* `filter` (String) Filter query to apply to the Cost Report
* `folder_token` (String) Token of the folder this Cost Report resides in.
* `groupings` (String) Grouping aggregations applied to the filtered data.
* `previous_period_end_date` (String) End date to apply to the Cost Report.
* `previous_period_start_date` (String) Start date to apply to the Cost Report.
* `saved_filter_tokens` (List of String) Saved filter tokens to be applied to the Cost Report.
* `settings` (Attributes) Settings for the Cost Report. (see [below for nested schema](#nestedatt--settings))
* `start_date` (String) Start date to apply to the Cost Report.
* `workspace_token` (String) Workspace token to add the Cost Report to.

### Read-Only

* `id` (String) Unique cost report identifier (aliases to token)
* `token` (String) Unique cost report identifier

<a id="nestedatt--chart_settings" />

### Nested Schema for `chart_settings`

Optional:

* `x_axis_dimension` (List of String) The dimension used to group or label data along the x-axis (e.g., by date, region, or service). NOTE: Only one value is allowed at this time. Defaults to \['date'].
* `y_axis_dimension` (String) The metric or measure displayed on the chart's y-axis. Possible values: 'cost', 'usage'. Defaults to 'cost'.

<a id="nestedatt--settings" />

### Nested Schema for `settings`

Optional:

* `aggregate_by` (String) Report will aggregate by cost or usage.
* `amortize` (Boolean) Report will amortize.
* `include_credits` (Boolean) Report will include credits.
* `include_discounts` (Boolean) Report will include discounts.
* `include_refunds` (Boolean) Report will include refunds.
* `include_tax` (Boolean) Report will include tax.
* `show_previous_period` (Boolean) Report will show previous period costs or usage comparison.
* `unallocated` (Boolean) Report will show unallocated costs.