vantage_cost_report (Resource)

​

Overview

​

Example Usage

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, count
    show_previous_period = false
  }

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

​

Schema

​

Required

• title (String) The title of the CostReport.

​

Optional

• business_metric_tokens_with_metadata (Attributes List) The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale. (see below for nested schema)
• chart_settings (Attributes) Report chart settings. (see below for nested schema)
• chart_type (String) The chart type of the CostReport.
• date_bin (String) The date bin of the CostReport.
• date_interval (String) The date interval of the CostReport. Incompatible with ‘start_date’ and ‘end_date’ parameters. Defaults to ‘this_month’ if start_date and end_date are not provided.
• default_forecast (Attributes) (see below for nested schema)
• end_date (String) The end date of the CostReport. ISO 8601 Formatted. Required when start_date is provided. Incompatible with ‘date_interval’ parameter.
• filter (String) The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
• folder_token (String) The token of the Folder to add the CostReport to. Determines the Workspace the report is assigned to.
• groupings (String) Grouping values for aggregating costs on the report. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, usage_unit, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
• previous_period_end_date (String) The previous period end date of the CostReport. ISO 8601 Formatted. Required when previous_period_start_date is provided.
• previous_period_start_date (String) The previous period start date of the CostReport. ISO 8601 Formatted.
• saved_filter_tokens (List of String) The tokens of the SavedFilters to apply to the CostReport.
• settings (Attributes) Report settings. (see below for nested schema)
• start_date (String) The start date of the CostReport. ISO 8601 Formatted. Incompatible with ‘date_interval’ parameter.
• workspace_token (String) The token of the Workspace to add the Cost Report to. Ignored if ‘folder_token’ is set. Required if the API token is associated with multiple Workspaces.

​

Read-Only

• created_at (String) The date and time, in UTC, the report was created. ISO 8601 Formatted.
• id (String) The id of the cost report
• token (String) The token of the cost report

​

Nested Schema for business_metric_tokens_with_metadata

• business_metric_token (String) The token of the BusinessMetric to attach to the CostReport.

• calculation_type (String) The calculation type applied when this BusinessMetric is used in the CostReport.
• label (String) Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type.
• label_filter (List of String) Include only values with these labels in the CostReport.
• label_filters (Map of List of String) Include only ClickHouse BusinessMetric values matching every label key and one of its values.
• unit_scale (String) Determines the scale of the BusinessMetric’s values within the CostReport.

​

Nested Schema for chart_settings

• 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’, ‘count’. Defaults to ‘cost’.

​

Nested Schema for default_forecast

• kind (String) The default forecast selection kind.

• report_forecast_token (String) The token for the report forecast selected as the default.

​

Nested Schema for settings

• aggregate_by (String) Report will aggregate by cost, usage, or count.
• amortize (Boolean) Report will amortize.
• complete_period (Boolean) Report will restrict date ranges to completed periods only.
• 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 cost, usage, or count comparison.
• unallocated (Boolean) Report will show unallocated costs.