Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vantage Provider
  3. API Docs
  4. CostReport
vantage 0.1.48 published on Tuesday, Mar 18, 2025 by vantage-sh
vantage-sh/terraform-provider-vantage

vantage.CostReport

Explore with Pulumi AI

vantage logo
vantage 0.1.48 published on Tuesday, Mar 18, 2025 by vantage-sh
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("demoReport", {
    filter: "costs.provider = 'aws'",
    folderToken: "fldr_3555785cd0409118",
    savedFilterTokens: [
        "svd_fltr_e844a2ccace05933",
        "svd_fltr_1b4b80a380ef4ba2",
    ],
    title: "Demo Report",
    workspaceToken: "wrkspc_47c3254c790e9351",
});

    import pulumi
import pulumi_vantage as vantage

demo_report = vantage.CostReport("demoReport",
    filter="costs.provider = 'aws'",
    folder_token="fldr_3555785cd0409118",
    saved_filter_tokens=[
        "svd_fltr_e844a2ccace05933",
        "svd_fltr_1b4b80a380ef4ba2",
    ],
    title="Demo Report",
    workspace_token="wrkspc_47c3254c790e9351")

    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, "demoReport", &vantage.CostReportArgs{
			Filter:      pulumi.String("costs.provider = 'aws'"),
			FolderToken: pulumi.String("fldr_3555785cd0409118"),
			SavedFilterTokens: pulumi.StringArray{
				pulumi.String("svd_fltr_e844a2ccace05933"),
				pulumi.String("svd_fltr_1b4b80a380ef4ba2"),
			},
			Title:          pulumi.String("Demo Report"),
			WorkspaceToken: pulumi.String("wrkspc_47c3254c790e9351"),
		})
		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("demoReport", new()
    {
        Filter = "costs.provider = 'aws'",
        FolderToken = "fldr_3555785cd0409118",
        SavedFilterTokens = new[]
        {
            "svd_fltr_e844a2ccace05933",
            "svd_fltr_1b4b80a380ef4ba2",
        },
        Title = "Demo Report",
        WorkspaceToken = "wrkspc_47c3254c790e9351",
    });

});

    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 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()
            .filter("costs.provider = 'aws'")
            .folderToken("fldr_3555785cd0409118")
            .savedFilterTokens(            
                "svd_fltr_e844a2ccace05933",
                "svd_fltr_1b4b80a380ef4ba2")
            .title("Demo Report")
            .workspaceToken("wrkspc_47c3254c790e9351")
            .build());

    }
}

    resources:
  demoReport:
    type: vantage:CostReport
    properties:
      filter: costs.provider = 'aws'
      folderToken: fldr_3555785cd0409118
      savedFilterTokens:
        - svd_fltr_e844a2ccace05933
        - svd_fltr_1b4b80a380ef4ba2
      title: Demo Report
      workspaceToken: wrkspc_47c3254c790e9351

    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,
               groupings: Optional[str] = None,
               date_interval: Optional[str] = None,
               end_date: Optional[str] = None,
               filter: Optional[str] = None,
               folder_token: Optional[str] = None,
               chart_type: Optional[str] = None,
               previous_period_end_date: Optional[str] = None,
               previous_period_start_date: Optional[str] = None,
               saved_filter_tokens: Optional[Sequence[str]] = None,
               start_date: Optional[str] = None,
               date_bin: Optional[str] = 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.

    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",
    Groupings = "string",
    DateInterval = "string",
    EndDate = "string",
    Filter = "string",
    FolderToken = "string",
    ChartType = "string",
    PreviousPeriodEndDate = "string",
    PreviousPeriodStartDate = "string",
    SavedFilterTokens = new[]
    {
        "string",
    },
    StartDate = "string",
    DateBin = "string",
    WorkspaceToken = "string",
});

    example, err := vantage.NewCostReport(ctx, "costReportResource", &vantage.CostReportArgs{
Title: pulumi.String("string"),
Groupings: pulumi.String("string"),
DateInterval: pulumi.String("string"),
EndDate: pulumi.String("string"),
Filter: pulumi.String("string"),
FolderToken: pulumi.String("string"),
ChartType: pulumi.String("string"),
PreviousPeriodEndDate: pulumi.String("string"),
PreviousPeriodStartDate: pulumi.String("string"),
SavedFilterTokens: pulumi.StringArray{
pulumi.String("string"),
},
StartDate: pulumi.String("string"),
DateBin: pulumi.String("string"),
WorkspaceToken: pulumi.String("string"),
})

    var costReportResource = new CostReport("costReportResource", CostReportArgs.builder()
    .title("string")
    .groupings("string")
    .dateInterval("string")
    .endDate("string")
    .filter("string")
    .folderToken("string")
    .chartType("string")
    .previousPeriodEndDate("string")
    .previousPeriodStartDate("string")
    .savedFilterTokens("string")
    .startDate("string")
    .dateBin("string")
    .workspaceToken("string")
    .build());

    cost_report_resource = vantage.CostReport("costReportResource",
    title="string",
    groupings="string",
    date_interval="string",
    end_date="string",
    filter="string",
    folder_token="string",
    chart_type="string",
    previous_period_end_date="string",
    previous_period_start_date="string",
    saved_filter_tokens=["string"],
    start_date="string",
    date_bin="string",
    workspace_token="string")

    const costReportResource = new vantage.CostReport("costReportResource", {
    title: "string",
    groupings: "string",
    dateInterval: "string",
    endDate: "string",
    filter: "string",
    folderToken: "string",
    chartType: "string",
    previousPeriodEndDate: "string",
    previousPeriodStartDate: "string",
    savedFilterTokens: ["string"],
    startDate: "string",
    dateBin: "string",
    workspaceToken: "string",
});

    type: vantage:CostReport
properties:
    chartType: string
    dateBin: string
    dateInterval: string
    endDate: string
    filter: string
    folderToken: string
    groupings: string
    previousPeriodEndDate: string
    previousPeriodStartDate: string
    savedFilterTokens:
        - string
    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
    Title of the Cost Report
    ChartType string
    Chart type to apply to the Cost Report.
    DateBin string
    Date bin to apply to the Cost Report.
    DateInterval string
    Date interval to apply to the Cost Report.
    EndDate string
    End date to apply to the Cost Report.
    Filter string
    Filter query to apply to the Cost Report
    FolderToken string
    Token of the folder this Cost Report resides in.
    Groupings string
    Grouping aggregations applied to the filtered data.
    PreviousPeriodEndDate string
    End date to apply to the Cost Report.
    PreviousPeriodStartDate string
    Start date to apply to the Cost Report.
    SavedFilterTokens List<string>
    Saved filter tokens to be applied to the Cost Report.
    StartDate string
    Start date to apply to the Cost Report.
    WorkspaceToken string
    Workspace token to add the Cost Report to.
    Title string
    Title of the Cost Report
    ChartType string
    Chart type to apply to the Cost Report.
    DateBin string
    Date bin to apply to the Cost Report.
    DateInterval string
    Date interval to apply to the Cost Report.
    EndDate string
    End date to apply to the Cost Report.
    Filter string
    Filter query to apply to the Cost Report
    FolderToken string
    Token of the folder this Cost Report resides in.
    Groupings string
    Grouping aggregations applied to the filtered data.
    PreviousPeriodEndDate string
    End date to apply to the Cost Report.
    PreviousPeriodStartDate string
    Start date to apply to the Cost Report.
    SavedFilterTokens []string
    Saved filter tokens to be applied to the Cost Report.
    StartDate string
    Start date to apply to the Cost Report.
    WorkspaceToken string
    Workspace token to add the Cost Report to.
    title String
    Title of the Cost Report
    chartType String
    Chart type to apply to the Cost Report.
    dateBin String
    Date bin to apply to the Cost Report.
    dateInterval String
    Date interval to apply to the Cost Report.
    endDate String
    End date to apply to the Cost Report.
    filter String
    Filter query to apply to the Cost Report
    folderToken String
    Token of the folder this Cost Report resides in.
    groupings String
    Grouping aggregations applied to the filtered data.
    previousPeriodEndDate String
    End date to apply to the Cost Report.
    previousPeriodStartDate String
    Start date to apply to the Cost Report.
    savedFilterTokens List<String>
    Saved filter tokens to be applied to the Cost Report.
    startDate String
    Start date to apply to the Cost Report.
    workspaceToken String
    Workspace token to add the Cost Report to.
    title string
    Title of the Cost Report
    chartType string
    Chart type to apply to the Cost Report.
    dateBin string
    Date bin to apply to the Cost Report.
    dateInterval string
    Date interval to apply to the Cost Report.
    endDate string
    End date to apply to the Cost Report.
    filter string
    Filter query to apply to the Cost Report
    folderToken string
    Token of the folder this Cost Report resides in.
    groupings string
    Grouping aggregations applied to the filtered data.
    previousPeriodEndDate string
    End date to apply to the Cost Report.
    previousPeriodStartDate string
    Start date to apply to the Cost Report.
    savedFilterTokens string[]
    Saved filter tokens to be applied to the Cost Report.
    startDate string
    Start date to apply to the Cost Report.
    workspaceToken string
    Workspace token to add the Cost Report to.
    title str
    Title of the Cost Report
    chart_type str
    Chart type to apply to the Cost Report.
    date_bin str
    Date bin to apply to the Cost Report.
    date_interval str
    Date interval to apply to the Cost Report.
    end_date str
    End date to apply to the Cost Report.
    filter str
    Filter query to apply to the Cost Report
    folder_token str
    Token of the folder this Cost Report resides in.
    groupings str
    Grouping aggregations applied to the filtered data.
    previous_period_end_date str
    End date to apply to the Cost Report.
    previous_period_start_date str
    Start date to apply to the Cost Report.
    saved_filter_tokens Sequence[str]
    Saved filter tokens to be applied to the Cost Report.
    start_date str
    Start date to apply to the Cost Report.
    workspace_token str
    Workspace token to add the Cost Report to.
    title String
    Title of the Cost Report
    chartType String
    Chart type to apply to the Cost Report.
    dateBin String
    Date bin to apply to the Cost Report.
    dateInterval String
    Date interval to apply to the Cost Report.
    endDate String
    End date to apply to the Cost Report.
    filter String
    Filter query to apply to the Cost Report
    folderToken String
    Token of the folder this Cost Report resides in.
    groupings String
    Grouping aggregations applied to the filtered data.
    previousPeriodEndDate String
    End date to apply to the Cost Report.
    previousPeriodStartDate String
    Start date to apply to the Cost Report.
    savedFilterTokens List<String>
    Saved filter tokens to be applied to the Cost Report.
    startDate String
    Start date to apply to the Cost Report.
    workspaceToken String
    Workspace token to add the Cost Report to.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    Unique cost report identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    Unique cost report identifier
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    Unique cost report identifier
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    Unique cost report identifier
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    Unique cost report identifier
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    Unique cost report identifier

    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,
        chart_type: Optional[str] = None,
        date_bin: Optional[str] = None,
        date_interval: Optional[str] = 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,
        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}
    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:
    ChartType string
    Chart type to apply to the Cost Report.
    DateBin string
    Date bin to apply to the Cost Report.
    DateInterval string
    Date interval to apply to the Cost Report.
    EndDate string
    End date to apply to the Cost Report.
    Filter string
    Filter query to apply to the Cost Report
    FolderToken string
    Token of the folder this Cost Report resides in.
    Groupings string
    Grouping aggregations applied to the filtered data.
    PreviousPeriodEndDate string
    End date to apply to the Cost Report.
    PreviousPeriodStartDate string
    Start date to apply to the Cost Report.
    SavedFilterTokens List<string>
    Saved filter tokens to be applied to the Cost Report.
    StartDate string
    Start date to apply to the Cost Report.
    Title string
    Title of the Cost Report
    Token string
    Unique cost report identifier
    WorkspaceToken string
    Workspace token to add the Cost Report to.
    ChartType string
    Chart type to apply to the Cost Report.
    DateBin string
    Date bin to apply to the Cost Report.
    DateInterval string
    Date interval to apply to the Cost Report.
    EndDate string
    End date to apply to the Cost Report.
    Filter string
    Filter query to apply to the Cost Report
    FolderToken string
    Token of the folder this Cost Report resides in.
    Groupings string
    Grouping aggregations applied to the filtered data.
    PreviousPeriodEndDate string
    End date to apply to the Cost Report.
    PreviousPeriodStartDate string
    Start date to apply to the Cost Report.
    SavedFilterTokens []string
    Saved filter tokens to be applied to the Cost Report.
    StartDate string
    Start date to apply to the Cost Report.
    Title string
    Title of the Cost Report
    Token string
    Unique cost report identifier
    WorkspaceToken string
    Workspace token to add the Cost Report to.
    chartType String
    Chart type to apply to the Cost Report.
    dateBin String
    Date bin to apply to the Cost Report.
    dateInterval String
    Date interval to apply to the Cost Report.
    endDate String
    End date to apply to the Cost Report.
    filter String
    Filter query to apply to the Cost Report
    folderToken String
    Token of the folder this Cost Report resides in.
    groupings String
    Grouping aggregations applied to the filtered data.
    previousPeriodEndDate String
    End date to apply to the Cost Report.
    previousPeriodStartDate String
    Start date to apply to the Cost Report.
    savedFilterTokens List<String>
    Saved filter tokens to be applied to the Cost Report.
    startDate String
    Start date to apply to the Cost Report.
    title String
    Title of the Cost Report
    token String
    Unique cost report identifier
    workspaceToken String
    Workspace token to add the Cost Report to.
    chartType string
    Chart type to apply to the Cost Report.
    dateBin string
    Date bin to apply to the Cost Report.
    dateInterval string
    Date interval to apply to the Cost Report.
    endDate string
    End date to apply to the Cost Report.
    filter string
    Filter query to apply to the Cost Report
    folderToken string
    Token of the folder this Cost Report resides in.
    groupings string
    Grouping aggregations applied to the filtered data.
    previousPeriodEndDate string
    End date to apply to the Cost Report.
    previousPeriodStartDate string
    Start date to apply to the Cost Report.
    savedFilterTokens string[]
    Saved filter tokens to be applied to the Cost Report.
    startDate string
    Start date to apply to the Cost Report.
    title string
    Title of the Cost Report
    token string
    Unique cost report identifier
    workspaceToken string
    Workspace token to add the Cost Report to.
    chart_type str
    Chart type to apply to the Cost Report.
    date_bin str
    Date bin to apply to the Cost Report.
    date_interval str
    Date interval to apply to the Cost Report.
    end_date str
    End date to apply to the Cost Report.
    filter str
    Filter query to apply to the Cost Report
    folder_token str
    Token of the folder this Cost Report resides in.
    groupings str
    Grouping aggregations applied to the filtered data.
    previous_period_end_date str
    End date to apply to the Cost Report.
    previous_period_start_date str
    Start date to apply to the Cost Report.
    saved_filter_tokens Sequence[str]
    Saved filter tokens to be applied to the Cost Report.
    start_date str
    Start date to apply to the Cost Report.
    title str
    Title of the Cost Report
    token str
    Unique cost report identifier
    workspace_token str
    Workspace token to add the Cost Report to.
    chartType String
    Chart type to apply to the Cost Report.
    dateBin String
    Date bin to apply to the Cost Report.
    dateInterval String
    Date interval to apply to the Cost Report.
    endDate String
    End date to apply to the Cost Report.
    filter String
    Filter query to apply to the Cost Report
    folderToken String
    Token of the folder this Cost Report resides in.
    groupings String
    Grouping aggregations applied to the filtered data.
    previousPeriodEndDate String
    End date to apply to the Cost Report.
    previousPeriodStartDate String
    Start date to apply to the Cost Report.
    savedFilterTokens List<String>
    Saved filter tokens to be applied to the Cost Report.
    startDate String
    Start date to apply to the Cost Report.
    title String
    Title of the Cost Report
    token String
    Unique cost report identifier
    workspaceToken String
    Workspace token to add the Cost Report to.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage logo
    vantage 0.1.48 published on Tuesday, Mar 18, 2025 by vantage-sh
    vantage-sh/terraform-provider-vantage