> ## 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_kubernetes_efficiency_report (Resource)

> Terraform resource reference for vantage_kubernetes_efficiency_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.

## Schema

### Required

* `title` (String) The title of the KubernetesEfficiencyReport.
* `workspace_token` (String) The Workspace in which the KubernetesEfficiencyReport will be created.

### Optional

* `aggregated_by` (String) The column by which the costs are aggregated.
* `date_bucket` (String) The date bucket of the KubernetesEfficiencyReport.
* `date_interval` (String) The date interval of the KubernetesEfficiencyReport. Incompatible with 'start\_date' and 'end\_date' parameters. Defaults to 'this\_month' if start\_date and end\_date are not provided.
* `end_date` (String) The end date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date\_interval' parameter.
* `filter` (String) The filter query language to apply to the KubernetesEfficiencyReport. Additional documentation available at [https://docs.vantage.sh/vql](https://docs.vantage.sh/vql).
* `groupings` (List of String) Grouping values for aggregating costs on the KubernetesEfficiencyReport. Valid groupings: cluster\_id, namespace, labeled, category, pod, label, `label:<label_name>`.
* `start_date` (String) The start date of the KubernetesEfficiencyReport. ISO 8601 Formatted. Incompatible with 'date\_interval' parameter.

### Read-Only

* `created_at` (String) The date and time, in UTC, the report was created. ISO 8601 Formatted.
* `default` (Boolean) Indicates whether the KubernetesEfficiencyReport is the default report.
* `id` (String) The id of the report
* `token` (String) The token of the report
* `user_token` (String) The token for the User who created this KubernetesEfficiencyReport.