Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vantage Provider
  4. API Docs
  5. CostReport
Viewing docs for vantage 0.4.4
published on Monday, Oct 26, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

vantage.CostReport

vantage
Viewing docs for vantage 0.4.4
published on Monday, Oct 26, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

    Manages a CostReport.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as vantage from "@pulumi/vantage";

const demoReport = new vantage.CostReport("demo_report", {
    title: "Demo Report",
    folderToken: "fldr_3555785cd0409118",
    filter: "costs.provider = 'aws'",
    savedFilterTokens: [
        "svd_fltr_e844a2ccace05933",
        "svd_fltr_1b4b80a380ef4ba2",
    ],
    workspaceToken: "wrkspc_47c3254c790e9351",
    chartType: "line",
    dateBin: "day",
    settings: {
        includeCredits: true,
        includeRefunds: true,
        includeDiscounts: true,
        includeTax: true,
        amortize: false,
        unallocated: false,
        aggregateBy: "cost",
        showPreviousPeriod: false,
    },
});

    import pulumi
import pulumi_vantage as vantage

demo_report = vantage.CostReport("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",
    date_bin="day",
    settings={
        "include_credits": True,
        "include_refunds": True,
        "include_discounts": True,
        "include_tax": True,
        "amortize": False,
        "unallocated": False,
        "aggregate_by": "cost",
        "show_previous_period": False,
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vantage/vantage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vantage.NewCostReport(ctx, "demo_report", &vantage.CostReportArgs{
			Title:       pulumi.String("Demo Report"),
			FolderToken: pulumi.String("fldr_3555785cd0409118"),
			Filter:      pulumi.String("costs.provider = 'aws'"),
			SavedFilterTokens: pulumi.StringArray{
				pulumi.String("svd_fltr_e844a2ccace05933"),
				pulumi.String("svd_fltr_1b4b80a380ef4ba2"),
			},
			WorkspaceToken: pulumi.String("wrkspc_47c3254c790e9351"),
			ChartType:      pulumi.String("line"),
			DateBin:        pulumi.String("day"),
			Settings: &vantage.CostReportSettingsArgs{
				IncludeCredits:     pulumi.Bool(true),
				IncludeRefunds:     pulumi.Bool(true),
				IncludeDiscounts:   pulumi.Bool(true),
				IncludeTax:         pulumi.Bool(true),
				Amortize:           pulumi.Bool(false),
				Unallocated:        pulumi.Bool(false),
				AggregateBy:        pulumi.String("cost"),
				ShowPreviousPeriod: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vantage = Pulumi.Vantage;

return await Deployment.RunAsync(() => 
{
    var demoReport = new Vantage.CostReport("demo_report", new()
    {
        Title = "Demo Report",
        FolderToken = "fldr_3555785cd0409118",
        Filter = "costs.provider = 'aws'",
        SavedFilterTokens = new[]
        {
            "svd_fltr_e844a2ccace05933",
            "svd_fltr_1b4b80a380ef4ba2",
        },
        WorkspaceToken = "wrkspc_47c3254c790e9351",
        ChartType = "line",
        DateBin = "day",
        Settings = new Vantage.Inputs.CostReportSettingsArgs
        {
            IncludeCredits = true,
            IncludeRefunds = true,
            IncludeDiscounts = true,
            IncludeTax = true,
            Amortize = false,
            Unallocated = false,
            AggregateBy = "cost",
            ShowPreviousPeriod = false,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vantage.CostReport;
import com.pulumi.vantage.CostReportArgs;
import com.pulumi.vantage.inputs.CostReportSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var demoReport = new CostReport("demoReport", CostReportArgs.builder()
            .title("Demo Report")
            .folderToken("fldr_3555785cd0409118")
            .filter("costs.provider = 'aws'")
            .savedFilterTokens(            
                "svd_fltr_e844a2ccace05933",
                "svd_fltr_1b4b80a380ef4ba2")
            .workspaceToken("wrkspc_47c3254c790e9351")
            .chartType("line")
            .dateBin("day")
            .settings(CostReportSettingsArgs.builder()
                .includeCredits(true)
                .includeRefunds(true)
                .includeDiscounts(true)
                .includeTax(true)
                .amortize(false)
                .unallocated(false)
                .aggregateBy("cost")
                .showPreviousPeriod(false)
                .build())
            .build());

    }
}

    resources:
  demoReport:
    type: vantage:CostReport
    name: demo_report
    properties:
      title: Demo Report
      folderToken: fldr_3555785cd0409118
      filter: costs.provider = 'aws'
      savedFilterTokens:
        - svd_fltr_e844a2ccace05933
        - svd_fltr_1b4b80a380ef4ba2
      workspaceToken: wrkspc_47c3254c790e9351
      chartType: line
      dateBin: day
      settings:
        includeCredits: true
        includeRefunds: true
        includeDiscounts: true
        includeTax: true
        amortize: false
        unallocated: false
        aggregateBy: cost
        showPreviousPeriod: false

    Example coming soon!

    Create CostReport Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CostReport(name: string, args: CostReportArgs, opts?: CustomResourceOptions);
    @overload
def CostReport(resource_name: str,
               args: CostReportArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def CostReport(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               title: Optional[str] = None,
               folder_token: Optional[str] = None,
               previous_period_end_date: Optional[str] = None,
               date_bin: Optional[str] = None,
               date_interval: Optional[str] = None,
               default_forecast: Optional[CostReportDefaultForecastArgs] = None,
               end_date: Optional[str] = None,
               chart_type: Optional[str] = None,
               filter: Optional[str] = None,
               groupings: Optional[str] = None,
               business_metric_tokens_with_metadatas: Optional[Sequence[CostReportBusinessMetricTokensWithMetadataArgs]] = None,
               previous_period_start_date: Optional[str] = None,
               saved_filter_tokens: Optional[Sequence[str]] = None,
               settings: Optional[CostReportSettingsArgs] = None,
               start_date: Optional[str] = None,
               chart_settings: Optional[CostReportChartSettingsArgs] = None,
               workspace_token: Optional[str] = None)
    func NewCostReport(ctx *Context, name string, args CostReportArgs, opts ...ResourceOption) (*CostReport, error)
    public CostReport(string name, CostReportArgs args, CustomResourceOptions? opts = null)
    public CostReport(String name, CostReportArgs args)
public CostReport(String name, CostReportArgs args, CustomResourceOptions options)

    type: vantage:CostReport
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "vantage_cost_report" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CostReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CostReportArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CostReportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CostReportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CostReportArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var costReportResource = new Vantage.CostReport("costReportResource", new()
{
    Title = "string",
    FolderToken = "string",
    PreviousPeriodEndDate = "string",
    DateBin = "string",
    DateInterval = "string",
    DefaultForecast = new Vantage.Inputs.CostReportDefaultForecastArgs
    {
        Kind = "string",
        ReportForecastToken = "string",
    },
    EndDate = "string",
    ChartType = "string",
    Filter = "string",
    Groupings = "string",
    BusinessMetricTokensWithMetadatas = new[]
    {
        new Vantage.Inputs.CostReportBusinessMetricTokensWithMetadataArgs
        {
            BusinessMetricToken = "string",
            CalculationType = "string",
            Label = "string",
            LabelFilter = new[]
            {
                "string",
            },
            LabelFilters = 
            {
                { "string", new[]
                {
                    "string",
                } },
            },
            UnitScale = "string",
        },
    },
    PreviousPeriodStartDate = "string",
    SavedFilterTokens = new[]
    {
        "string",
    },
    Settings = new Vantage.Inputs.CostReportSettingsArgs
    {
        AggregateBy = "string",
        Amortize = false,
        CompletePeriod = false,
        IncludeCredits = false,
        IncludeDiscounts = false,
        IncludeRefunds = false,
        IncludeTax = false,
        ShowPreviousPeriod = false,
        Unallocated = false,
    },
    StartDate = "string",
    ChartSettings = new Vantage.Inputs.CostReportChartSettingsArgs
    {
        XAxisDimensions = new[]
        {
            "string",
        },
        YAxisDimension = "string",
    },
    WorkspaceToken = "string",
});

    example, err := vantage.NewCostReport(ctx, "costReportResource", &vantage.CostReportArgs{
	Title:                 pulumi.String("string"),
	FolderToken:           pulumi.String("string"),
	PreviousPeriodEndDate: pulumi.String("string"),
	DateBin:               pulumi.String("string"),
	DateInterval:          pulumi.String("string"),
	DefaultForecast: &vantage.CostReportDefaultForecastArgs{
		Kind:                pulumi.String("string"),
		ReportForecastToken: pulumi.String("string"),
	},
	EndDate:   pulumi.String("string"),
	ChartType: pulumi.String("string"),
	Filter:    pulumi.String("string"),
	Groupings: pulumi.String("string"),
	BusinessMetricTokensWithMetadatas: vantage.CostReportBusinessMetricTokensWithMetadataArray{
		&vantage.CostReportBusinessMetricTokensWithMetadataArgs{
			BusinessMetricToken: pulumi.String("string"),
			CalculationType:     pulumi.String("string"),
			Label:               pulumi.String("string"),
			LabelFilter: pulumi.StringArray{
				pulumi.String("string"),
			},
			LabelFilters: pulumi.StringArrayMap{
				"string": pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			UnitScale: pulumi.String("string"),
		},
	},
	PreviousPeriodStartDate: pulumi.String("string"),
	SavedFilterTokens: pulumi.StringArray{
		pulumi.String("string"),
	},
	Settings: &vantage.CostReportSettingsArgs{
		AggregateBy:        pulumi.String("string"),
		Amortize:           pulumi.Bool(false),
		CompletePeriod:     pulumi.Bool(false),
		IncludeCredits:     pulumi.Bool(false),
		IncludeDiscounts:   pulumi.Bool(false),
		IncludeRefunds:     pulumi.Bool(false),
		IncludeTax:         pulumi.Bool(false),
		ShowPreviousPeriod: pulumi.Bool(false),
		Unallocated:        pulumi.Bool(false),
	},
	StartDate: pulumi.String("string"),
	ChartSettings: &vantage.CostReportChartSettingsArgs{
		XAxisDimensions: pulumi.StringArray{
			pulumi.String("string"),
		},
		YAxisDimension: pulumi.String("string"),
	},
	WorkspaceToken: pulumi.String("string"),
})

    resource "vantage_cost_report" "costReportResource" {
  lifecycle {
    create_before_destroy = true
  }
  title                    = "string"
  folder_token             = "string"
  previous_period_end_date = "string"
  date_bin                 = "string"
  date_interval            = "string"
  default_forecast = {
    kind                  = "string"
    report_forecast_token = "string"
  }
  end_date   = "string"
  chart_type = "string"
  filter     = "string"
  groupings  = "string"
  business_metric_tokens_with_metadatas {
    business_metric_token = "string"
    calculation_type      = "string"
    label                 = "string"
    label_filter          = ["string"]
    label_filters = {
      "string" = ["string"]
    }
    unit_scale = "string"
  }
  previous_period_start_date = "string"
  saved_filter_tokens        = ["string"]
  settings = {
    aggregate_by         = "string"
    amortize             = false
    complete_period      = false
    include_credits      = false
    include_discounts    = false
    include_refunds      = false
    include_tax          = false
    show_previous_period = false
    unallocated          = false
  }
  start_date = "string"
  chart_settings = {
    x_axis_dimensions = ["string"]
    y_axis_dimension  = "string"
  }
  workspace_token = "string"
}

    var costReportResource = new CostReport("costReportResource", CostReportArgs.builder()
    .title("string")
    .folderToken("string")
    .previousPeriodEndDate("string")
    .dateBin("string")
    .dateInterval("string")
    .defaultForecast(CostReportDefaultForecastArgs.builder()
        .kind("string")
        .reportForecastToken("string")
        .build())
    .endDate("string")
    .chartType("string")
    .filter("string")
    .groupings("string")
    .businessMetricTokensWithMetadatas(CostReportBusinessMetricTokensWithMetadataArgs.builder()
        .businessMetricToken("string")
        .calculationType("string")
        .label("string")
        .labelFilter("string")
        .labelFilters(Map.of("string", Arrays.asList("string")))
        .unitScale("string")
        .build())
    .previousPeriodStartDate("string")
    .savedFilterTokens("string")
    .settings(CostReportSettingsArgs.builder()
        .aggregateBy("string")
        .amortize(false)
        .completePeriod(false)
        .includeCredits(false)
        .includeDiscounts(false)
        .includeRefunds(false)
        .includeTax(false)
        .showPreviousPeriod(false)
        .unallocated(false)
        .build())
    .startDate("string")
    .chartSettings(CostReportChartSettingsArgs.builder()
        .xAxisDimensions("string")
        .yAxisDimension("string")
        .build())
    .workspaceToken("string")
    .build());

    cost_report_resource = vantage.CostReport("costReportResource",
    title="string",
    folder_token="string",
    previous_period_end_date="string",
    date_bin="string",
    date_interval="string",
    default_forecast={
        "kind": "string",
        "report_forecast_token": "string",
    },
    end_date="string",
    chart_type="string",
    filter="string",
    groupings="string",
    business_metric_tokens_with_metadatas=[{
        "business_metric_token": "string",
        "calculation_type": "string",
        "label": "string",
        "label_filter": ["string"],
        "label_filters": {
            "string": ["string"],
        },
        "unit_scale": "string",
    }],
    previous_period_start_date="string",
    saved_filter_tokens=["string"],
    settings={
        "aggregate_by": "string",
        "amortize": False,
        "complete_period": False,
        "include_credits": False,
        "include_discounts": False,
        "include_refunds": False,
        "include_tax": False,
        "show_previous_period": False,
        "unallocated": False,
    },
    start_date="string",
    chart_settings={
        "x_axis_dimensions": ["string"],
        "y_axis_dimension": "string",
    },
    workspace_token="string")

    const costReportResource = new vantage.CostReport("costReportResource", {
    title: "string",
    folderToken: "string",
    previousPeriodEndDate: "string",
    dateBin: "string",
    dateInterval: "string",
    defaultForecast: {
        kind: "string",
        reportForecastToken: "string",
    },
    endDate: "string",
    chartType: "string",
    filter: "string",
    groupings: "string",
    businessMetricTokensWithMetadatas: [{
        businessMetricToken: "string",
        calculationType: "string",
        label: "string",
        labelFilter: ["string"],
        labelFilters: {
            string: ["string"],
        },
        unitScale: "string",
    }],
    previousPeriodStartDate: "string",
    savedFilterTokens: ["string"],
    settings: {
        aggregateBy: "string",
        amortize: false,
        completePeriod: false,
        includeCredits: false,
        includeDiscounts: false,
        includeRefunds: false,
        includeTax: false,
        showPreviousPeriod: false,
        unallocated: false,
    },
    startDate: "string",
    chartSettings: {
        xAxisDimensions: ["string"],
        yAxisDimension: "string",
    },
    workspaceToken: "string",
});

    type: vantage:CostReport
properties:
    businessMetricTokensWithMetadatas:
        - businessMetricToken: string
          calculationType: string
          label: string
          labelFilter:
            - string
          labelFilters:
            string:
                - string
          unitScale: string
    chartSettings:
        xAxisDimensions:
            - string
        yAxisDimension: string
    chartType: string
    dateBin: string
    dateInterval: string
    defaultForecast:
        kind: string
        reportForecastToken: string
    endDate: string
    filter: string
    folderToken: string
    groupings: string
    previousPeriodEndDate: string
    previousPeriodStartDate: string
    savedFilterTokens:
        - string
    settings:
        aggregateBy: string
        amortize: false
        completePeriod: false
        includeCredits: false
        includeDiscounts: false
        includeRefunds: false
        includeTax: false
        showPreviousPeriod: false
        unallocated: false
    startDate: string
    title: string
    workspaceToken: string

    CostReport Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CostReport resource accepts the following input properties:

    Title string
    The title of the CostReport.
    BusinessMetricTokensWithMetadatas List<CostReportBusinessMetricTokensWithMetadata>
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    ChartSettings CostReportChartSettings
    Report chart settings.
    ChartType string
    The chart type of the CostReport.
    DateBin string
    The date bin of the CostReport.
    DateInterval string
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    DefaultForecast CostReportDefaultForecast
    EndDate string
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    Filter string
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    FolderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    PreviousPeriodEndDate string
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    PreviousPeriodStartDate string
    The previous period start date of the CostReport. ISO 8601 Formatted.
    SavedFilterTokens List<string>
    The tokens of the SavedFilters to apply to the CostReport.
    Settings CostReportSettings
    Report settings.
    StartDate string
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    WorkspaceToken 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.
    Title string
    The title of the CostReport.
    BusinessMetricTokensWithMetadatas []CostReportBusinessMetricTokensWithMetadataArgs
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    ChartSettings CostReportChartSettingsArgs
    Report chart settings.
    ChartType string
    The chart type of the CostReport.
    DateBin string
    The date bin of the CostReport.
    DateInterval string
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    DefaultForecast CostReportDefaultForecastArgs
    EndDate string
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    Filter string
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    FolderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    PreviousPeriodEndDate string
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    PreviousPeriodStartDate string
    The previous period start date of the CostReport. ISO 8601 Formatted.
    SavedFilterTokens []string
    The tokens of the SavedFilters to apply to the CostReport.
    Settings CostReportSettingsArgs
    Report settings.
    StartDate string
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    WorkspaceToken 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.
    title string
    The title of the CostReport.
    business_metric_tokens_with_metadatas list(object)
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chart_settings object
    Report chart settings.
    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 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    default_forecast object
    end_date string
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. 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 previousperiodstart_date is provided.
    previous_period_start_date string
    The previous period start date of the CostReport. ISO 8601 Formatted.
    saved_filter_tokens list(string)
    The tokens of the SavedFilters to apply to the CostReport.
    settings object
    Report settings.
    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.
    title String
    The title of the CostReport.
    businessMetricTokensWithMetadatas List<CostReportBusinessMetricTokensWithMetadata>
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chartSettings CostReportChartSettings
    Report chart settings.
    chartType String
    The chart type of the CostReport.
    dateBin String
    The date bin of the CostReport.
    dateInterval String
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    defaultForecast CostReportDefaultForecast
    endDate String
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    filter String
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    folderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    previousPeriodEndDate String
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    previousPeriodStartDate String
    The previous period start date of the CostReport. ISO 8601 Formatted.
    savedFilterTokens List<String>
    The tokens of the SavedFilters to apply to the CostReport.
    settings CostReportSettings
    Report settings.
    startDate String
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    workspaceToken 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.
    title string
    The title of the CostReport.
    businessMetricTokensWithMetadatas CostReportBusinessMetricTokensWithMetadata[]
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chartSettings CostReportChartSettings
    Report chart settings.
    chartType string
    The chart type of the CostReport.
    dateBin string
    The date bin of the CostReport.
    dateInterval string
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    defaultForecast CostReportDefaultForecast
    endDate string
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    filter string
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    folderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    previousPeriodEndDate string
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    previousPeriodStartDate string
    The previous period start date of the CostReport. ISO 8601 Formatted.
    savedFilterTokens string[]
    The tokens of the SavedFilters to apply to the CostReport.
    settings CostReportSettings
    Report settings.
    startDate string
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    workspaceToken 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.
    title str
    The title of the CostReport.
    business_metric_tokens_with_metadatas Sequence[CostReportBusinessMetricTokensWithMetadataArgs]
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chart_settings CostReportChartSettingsArgs
    Report chart settings.
    chart_type str
    The chart type of the CostReport.
    date_bin str
    The date bin of the CostReport.
    date_interval str
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    default_forecast CostReportDefaultForecastArgs
    end_date str
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    filter str
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    folder_token str
    The token of the Folder to add the CostReport to. Determines the Workspace the report is assigned to.
    groupings str
    Grouping values for aggregating costs on the report. Valid groupings: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    previous_period_end_date str
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    previous_period_start_date str
    The previous period start date of the CostReport. ISO 8601 Formatted.
    saved_filter_tokens Sequence[str]
    The tokens of the SavedFilters to apply to the CostReport.
    settings CostReportSettingsArgs
    Report settings.
    start_date str
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    workspace_token str
    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.
    title String
    The title of the CostReport.
    businessMetricTokensWithMetadatas List<Property Map>
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chartSettings Property Map
    Report chart settings.
    chartType String
    The chart type of the CostReport.
    dateBin String
    The date bin of the CostReport.
    dateInterval String
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    defaultForecast Property Map
    endDate String
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    filter String
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    folderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    previousPeriodEndDate String
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    previousPeriodStartDate String
    The previous period start date of the CostReport. ISO 8601 Formatted.
    savedFilterTokens List<String>
    The tokens of the SavedFilters to apply to the CostReport.
    settings Property Map
    Report settings.
    startDate String
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    workspaceToken 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CostReport resource produces the following output properties:

    CreatedAt string
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the cost report
    CreatedAt string
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the cost report
    created_at string
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the cost report
    createdAt String
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the cost report
    createdAt string
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the cost report
    created_at str
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token of the cost report
    createdAt String
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the cost report

    Look up Existing CostReport Resource

    Get an existing CostReport resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CostReportState, opts?: CustomResourceOptions): CostReport
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        business_metric_tokens_with_metadatas: Optional[Sequence[CostReportBusinessMetricTokensWithMetadataArgs]] = None,
        chart_settings: Optional[CostReportChartSettingsArgs] = None,
        chart_type: Optional[str] = None,
        created_at: Optional[str] = None,
        date_bin: Optional[str] = None,
        date_interval: Optional[str] = None,
        default_forecast: Optional[CostReportDefaultForecastArgs] = None,
        end_date: Optional[str] = None,
        filter: Optional[str] = None,
        folder_token: Optional[str] = None,
        groupings: Optional[str] = None,
        previous_period_end_date: Optional[str] = None,
        previous_period_start_date: Optional[str] = None,
        saved_filter_tokens: Optional[Sequence[str]] = None,
        settings: Optional[CostReportSettingsArgs] = None,
        start_date: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        workspace_token: Optional[str] = None) -> CostReport
    func GetCostReport(ctx *Context, name string, id IDInput, state *CostReportState, opts ...ResourceOption) (*CostReport, error)
    public static CostReport Get(string name, Input<string> id, CostReportState? state, CustomResourceOptions? opts = null)
    public static CostReport get(String name, Output<String> id, CostReportState state, CustomResourceOptions options)
    resources:  _:    type: vantage:CostReport    get:      id: ${id}
    import {
  to = vantage_cost_report.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BusinessMetricTokensWithMetadatas List<CostReportBusinessMetricTokensWithMetadata>
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    ChartSettings CostReportChartSettings
    Report chart settings.
    ChartType string
    The chart type of the CostReport.
    CreatedAt string
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    DateBin string
    The date bin of the CostReport.
    DateInterval string
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    DefaultForecast CostReportDefaultForecast
    EndDate string
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    Filter string
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    FolderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    PreviousPeriodEndDate string
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    PreviousPeriodStartDate string
    The previous period start date of the CostReport. ISO 8601 Formatted.
    SavedFilterTokens List<string>
    The tokens of the SavedFilters to apply to the CostReport.
    Settings CostReportSettings
    Report settings.
    StartDate string
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    Title string
    The title of the CostReport.
    Token string
    The token of the cost report
    WorkspaceToken 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.
    BusinessMetricTokensWithMetadatas []CostReportBusinessMetricTokensWithMetadataArgs
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    ChartSettings CostReportChartSettingsArgs
    Report chart settings.
    ChartType string
    The chart type of the CostReport.
    CreatedAt string
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    DateBin string
    The date bin of the CostReport.
    DateInterval string
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    DefaultForecast CostReportDefaultForecastArgs
    EndDate string
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    Filter string
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    FolderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    PreviousPeriodEndDate string
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    PreviousPeriodStartDate string
    The previous period start date of the CostReport. ISO 8601 Formatted.
    SavedFilterTokens []string
    The tokens of the SavedFilters to apply to the CostReport.
    Settings CostReportSettingsArgs
    Report settings.
    StartDate string
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    Title string
    The title of the CostReport.
    Token string
    The token of the cost report
    WorkspaceToken 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.
    business_metric_tokens_with_metadatas list(object)
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chart_settings object
    Report chart settings.
    chart_type string
    The chart type of the CostReport.
    created_at string
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    date_bin string
    The date bin of the CostReport.
    date_interval string
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    default_forecast object
    end_date string
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. 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 previousperiodstart_date is provided.
    previous_period_start_date string
    The previous period start date of the CostReport. ISO 8601 Formatted.
    saved_filter_tokens list(string)
    The tokens of the SavedFilters to apply to the CostReport.
    settings object
    Report settings.
    start_date string
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title string
    The title of the CostReport.
    token string
    The token of the cost report
    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.
    businessMetricTokensWithMetadatas List<CostReportBusinessMetricTokensWithMetadata>
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chartSettings CostReportChartSettings
    Report chart settings.
    chartType String
    The chart type of the CostReport.
    createdAt String
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    dateBin String
    The date bin of the CostReport.
    dateInterval String
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    defaultForecast CostReportDefaultForecast
    endDate String
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    filter String
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    folderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    previousPeriodEndDate String
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    previousPeriodStartDate String
    The previous period start date of the CostReport. ISO 8601 Formatted.
    savedFilterTokens List<String>
    The tokens of the SavedFilters to apply to the CostReport.
    settings CostReportSettings
    Report settings.
    startDate String
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title String
    The title of the CostReport.
    token String
    The token of the cost report
    workspaceToken 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.
    businessMetricTokensWithMetadatas CostReportBusinessMetricTokensWithMetadata[]
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chartSettings CostReportChartSettings
    Report chart settings.
    chartType string
    The chart type of the CostReport.
    createdAt string
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    dateBin string
    The date bin of the CostReport.
    dateInterval string
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    defaultForecast CostReportDefaultForecast
    endDate string
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    filter string
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    folderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    previousPeriodEndDate string
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    previousPeriodStartDate string
    The previous period start date of the CostReport. ISO 8601 Formatted.
    savedFilterTokens string[]
    The tokens of the SavedFilters to apply to the CostReport.
    settings CostReportSettings
    Report settings.
    startDate string
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title string
    The title of the CostReport.
    token string
    The token of the cost report
    workspaceToken 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.
    business_metric_tokens_with_metadatas Sequence[CostReportBusinessMetricTokensWithMetadataArgs]
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chart_settings CostReportChartSettingsArgs
    Report chart settings.
    chart_type str
    The chart type of the CostReport.
    created_at str
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    date_bin str
    The date bin of the CostReport.
    date_interval str
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    default_forecast CostReportDefaultForecastArgs
    end_date str
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    filter str
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    folder_token str
    The token of the Folder to add the CostReport to. Determines the Workspace the report is assigned to.
    groupings str
    Grouping values for aggregating costs on the report. Valid groupings: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    previous_period_end_date str
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    previous_period_start_date str
    The previous period start date of the CostReport. ISO 8601 Formatted.
    saved_filter_tokens Sequence[str]
    The tokens of the SavedFilters to apply to the CostReport.
    settings CostReportSettingsArgs
    Report settings.
    start_date str
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title str
    The title of the CostReport.
    token str
    The token of the cost report
    workspace_token str
    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.
    businessMetricTokensWithMetadatas List<Property Map>
    The tokens for any BusinessMetrics to attach to the CostReport, and the unit scale.
    chartSettings Property Map
    Report chart settings.
    chartType String
    The chart type of the CostReport.
    createdAt String
    The date and time, in UTC, the report was created. ISO 8601 Formatted.
    dateBin String
    The date bin of the CostReport.
    dateInterval String
    The date interval of the CostReport. Incompatible with 'startdate' and 'enddate' parameters. Defaults to 'thismonth' if startdate and end_date are not provided.
    defaultForecast Property Map
    endDate String
    The end date of the CostReport. ISO 8601 Formatted. Required when startdate is provided. Incompatible with 'dateinterval' parameter.
    filter String
    The filter query language to apply to the CostReport. Additional documentation available at https://docs.vantage.sh/vql.
    folderToken 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: accountid, billingaccountid, chargetype, costcategory, costsubcategory, provider, region, resourceid, service, tagged, usageunit, tag:\n\n. If providing multiple groupings, join as comma separated values: groupings=provider,service,region
    previousPeriodEndDate String
    The previous period end date of the CostReport. ISO 8601 Formatted. Required when previousperiodstart_date is provided.
    previousPeriodStartDate String
    The previous period start date of the CostReport. ISO 8601 Formatted.
    savedFilterTokens List<String>
    The tokens of the SavedFilters to apply to the CostReport.
    settings Property Map
    Report settings.
    startDate String
    The start date of the CostReport. ISO 8601 Formatted. Incompatible with 'date_interval' parameter.
    title String
    The title of the CostReport.
    token String
    The token of the cost report
    workspaceToken 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.

    Supporting Types

    CostReportBusinessMetricTokensWithMetadata, CostReportBusinessMetricTokensWithMetadataArgs

    BusinessMetricToken string
    The token of the BusinessMetric to attach to the CostReport.
    CalculationType 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.
    LabelFilter List<string>
    Include only values with these labels in the CostReport.
    LabelFilters Dictionary<string, ImmutableArray<string>>
    Include only ClickHouse BusinessMetric values matching every label key and one of its values.
    UnitScale string
    Determines the scale of the BusinessMetric's values within the CostReport.
    BusinessMetricToken string
    The token of the BusinessMetric to attach to the CostReport.
    CalculationType 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.
    LabelFilter []string
    Include only values with these labels in the CostReport.
    LabelFilters map[string][]string
    Include only ClickHouse BusinessMetric values matching every label key and one of its values.
    UnitScale string
    Determines the scale of the BusinessMetric's values within the CostReport.
    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(string)
    Include only values with these labels in the CostReport.
    label_filters map(list(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.
    businessMetricToken String
    The token of the BusinessMetric to attach to the CostReport.
    calculationType 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.
    labelFilter List<String>
    Include only values with these labels in the CostReport.
    labelFilters Map<String,List<String>>
    Include only ClickHouse BusinessMetric values matching every label key and one of its values.
    unitScale String
    Determines the scale of the BusinessMetric's values within the CostReport.
    businessMetricToken string
    The token of the BusinessMetric to attach to the CostReport.
    calculationType 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.
    labelFilter string[]
    Include only values with these labels in the CostReport.
    labelFilters {[key: string]: string[]}
    Include only ClickHouse BusinessMetric values matching every label key and one of its values.
    unitScale string
    Determines the scale of the BusinessMetric's values within the CostReport.
    business_metric_token str
    The token of the BusinessMetric to attach to the CostReport.
    calculation_type str
    The calculation type applied when this BusinessMetric is used in the CostReport.
    label str
    Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type.
    label_filter Sequence[str]
    Include only values with these labels in the CostReport.
    label_filters Mapping[str, Sequence[str]]
    Include only ClickHouse BusinessMetric values matching every label key and one of its values.
    unit_scale str
    Determines the scale of the BusinessMetric's values within the CostReport.
    businessMetricToken String
    The token of the BusinessMetric to attach to the CostReport.
    calculationType 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.
    labelFilter List<String>
    Include only values with these labels in the CostReport.
    labelFilters Map<List<String>>
    Include only ClickHouse BusinessMetric values matching every label key and one of its values.
    unitScale String
    Determines the scale of the BusinessMetric's values within the CostReport.

    CostReportChartSettings, CostReportChartSettingsArgs

    XAxisDimensions List<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'].
    YAxisDimension string
    The metric or measure displayed on the chart's y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
    XAxisDimensions []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'].
    YAxisDimension string
    The metric or measure displayed on the chart's y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
    x_axis_dimensions list(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'.
    xAxisDimensions List<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'].
    yAxisDimension String
    The metric or measure displayed on the chart's y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
    xAxisDimensions 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'].
    yAxisDimension string
    The metric or measure displayed on the chart's y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
    x_axis_dimensions Sequence[str]
    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 str
    The metric or measure displayed on the chart's y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.
    xAxisDimensions List<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'].
    yAxisDimension String
    The metric or measure displayed on the chart's y-axis. Possible values: 'cost', 'usage', 'count'. Defaults to 'cost'.

    CostReportDefaultForecast, CostReportDefaultForecastArgs

    Kind string
    The default forecast selection kind.
    ReportForecastToken string
    The token for the report forecast selected as the default.
    Kind string
    The default forecast selection kind.
    ReportForecastToken string
    The token for the report forecast selected as the default.
    kind string
    The default forecast selection kind.
    report_forecast_token string
    The token for the report forecast selected as the default.
    kind String
    The default forecast selection kind.
    reportForecastToken String
    The token for the report forecast selected as the default.
    kind string
    The default forecast selection kind.
    reportForecastToken string
    The token for the report forecast selected as the default.
    kind str
    The default forecast selection kind.
    report_forecast_token str
    The token for the report forecast selected as the default.
    kind String
    The default forecast selection kind.
    reportForecastToken String
    The token for the report forecast selected as the default.

    CostReportSettings, CostReportSettingsArgs

    AggregateBy string
    Report will aggregate by cost, usage, or count.
    Amortize bool
    Report will amortize.
    CompletePeriod bool
    Report will restrict date ranges to completed periods only.
    IncludeCredits bool
    Report will include credits.
    IncludeDiscounts bool
    Report will include discounts.
    IncludeRefunds bool
    Report will include refunds.
    IncludeTax bool
    Report will include tax.
    ShowPreviousPeriod bool
    Report will show previous period cost, usage, or count comparison.
    Unallocated bool
    Report will show unallocated costs.
    AggregateBy string
    Report will aggregate by cost, usage, or count.
    Amortize bool
    Report will amortize.
    CompletePeriod bool
    Report will restrict date ranges to completed periods only.
    IncludeCredits bool
    Report will include credits.
    IncludeDiscounts bool
    Report will include discounts.
    IncludeRefunds bool
    Report will include refunds.
    IncludeTax bool
    Report will include tax.
    ShowPreviousPeriod bool
    Report will show previous period cost, usage, or count comparison.
    Unallocated bool
    Report will show unallocated costs.
    aggregate_by string
    Report will aggregate by cost, usage, or count.
    amortize bool
    Report will amortize.
    complete_period bool
    Report will restrict date ranges to completed periods only.
    include_credits bool
    Report will include credits.
    include_discounts bool
    Report will include discounts.
    include_refunds bool
    Report will include refunds.
    include_tax bool
    Report will include tax.
    show_previous_period bool
    Report will show previous period cost, usage, or count comparison.
    unallocated bool
    Report will show unallocated costs.
    aggregateBy String
    Report will aggregate by cost, usage, or count.
    amortize Boolean
    Report will amortize.
    completePeriod Boolean
    Report will restrict date ranges to completed periods only.
    includeCredits Boolean
    Report will include credits.
    includeDiscounts Boolean
    Report will include discounts.
    includeRefunds Boolean
    Report will include refunds.
    includeTax Boolean
    Report will include tax.
    showPreviousPeriod Boolean
    Report will show previous period cost, usage, or count comparison.
    unallocated Boolean
    Report will show unallocated costs.
    aggregateBy string
    Report will aggregate by cost, usage, or count.
    amortize boolean
    Report will amortize.
    completePeriod boolean
    Report will restrict date ranges to completed periods only.
    includeCredits boolean
    Report will include credits.
    includeDiscounts boolean
    Report will include discounts.
    includeRefunds boolean
    Report will include refunds.
    includeTax boolean
    Report will include tax.
    showPreviousPeriod boolean
    Report will show previous period cost, usage, or count comparison.
    unallocated boolean
    Report will show unallocated costs.
    aggregate_by str
    Report will aggregate by cost, usage, or count.
    amortize bool
    Report will amortize.
    complete_period bool
    Report will restrict date ranges to completed periods only.
    include_credits bool
    Report will include credits.
    include_discounts bool
    Report will include discounts.
    include_refunds bool
    Report will include refunds.
    include_tax bool
    Report will include tax.
    show_previous_period bool
    Report will show previous period cost, usage, or count comparison.
    unallocated bool
    Report will show unallocated costs.
    aggregateBy String
    Report will aggregate by cost, usage, or count.
    amortize Boolean
    Report will amortize.
    completePeriod Boolean
    Report will restrict date ranges to completed periods only.
    includeCredits Boolean
    Report will include credits.
    includeDiscounts Boolean
    Report will include discounts.
    includeRefunds Boolean
    Report will include refunds.
    includeTax Boolean
    Report will include tax.
    showPreviousPeriod Boolean
    Report will show previous period cost, usage, or count comparison.
    unallocated Boolean
    Report will show unallocated costs.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage
    Viewing docs for vantage 0.4.4
    published on Monday, Oct 26, 2026 by vantage-sh
    Schema (JSON)
    vantage-sh/terraform-provider-vantage

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial