1. Packages
  2. Vantage
  3. API Docs
  4. CostReport
Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs

vantage.CostReport

Explore with Pulumi AI

vantage logo
Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs

    Manages a CostReport.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vantage = Lbrlabs.PulumiPackage.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",
        });
    
    });
    
    package main
    
    import (
    	"github.com/lbrlabs/pulumi-vantage/sdk/go/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"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_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")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as vantage from "@lbrlabs/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",
    });
    
    resources:
      demoReport:
        type: vantage:CostReport
        properties:
          filter: costs.provider = 'aws'
          folderToken: fldr_3555785cd0409118
          savedFilterTokens:
            - svd_fltr_e844a2ccace05933
            - svd_fltr_1b4b80a380ef4ba2
          title: Demo Report
    

    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,
                   filter: Optional[str] = None,
                   folder_token: Optional[str] = None,
                   saved_filter_tokens: Optional[Sequence[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.

    Example

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

    var costReportResource = new Vantage.CostReport("costReportResource", new()
    {
        Title = "string",
        Filter = "string",
        FolderToken = "string",
        SavedFilterTokens = new[]
        {
            "string",
        },
        WorkspaceToken = "string",
    });
    
    example, err := vantage.NewCostReport(ctx, "costReportResource", &vantage.CostReportArgs{
    	Title:       pulumi.String("string"),
    	Filter:      pulumi.String("string"),
    	FolderToken: pulumi.String("string"),
    	SavedFilterTokens: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	WorkspaceToken: pulumi.String("string"),
    })
    
    var costReportResource = new CostReport("costReportResource", CostReportArgs.builder()        
        .title("string")
        .filter("string")
        .folderToken("string")
        .savedFilterTokens("string")
        .workspaceToken("string")
        .build());
    
    cost_report_resource = vantage.CostReport("costReportResource",
        title="string",
        filter="string",
        folder_token="string",
        saved_filter_tokens=["string"],
        workspace_token="string")
    
    const costReportResource = new vantage.CostReport("costReportResource", {
        title: "string",
        filter: "string",
        folderToken: "string",
        savedFilterTokens: ["string"],
        workspaceToken: "string",
    });
    
    type: vantage:CostReport
    properties:
        filter: string
        folderToken: string
        savedFilterTokens:
            - 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

    The CostReport resource accepts the following input properties:

    Title string
    Title of the Cost Report
    Filter string
    Filter query to apply to the Cost Report
    FolderToken string
    Token of the folder this report resides in.
    SavedFilterTokens List<string>
    Saved filter tokens to be applied to the report.
    WorkspaceToken string
    Workspace token to add the cost report to.
    Title string
    Title of the Cost Report
    Filter string
    Filter query to apply to the Cost Report
    FolderToken string
    Token of the folder this report resides in.
    SavedFilterTokens []string
    Saved filter tokens to be applied to the report.
    WorkspaceToken string
    Workspace token to add the cost report to.
    title String
    Title of the Cost Report
    filter String
    Filter query to apply to the Cost Report
    folderToken String
    Token of the folder this report resides in.
    savedFilterTokens List<String>
    Saved filter tokens to be applied to the report.
    workspaceToken String
    Workspace token to add the cost report to.
    title string
    Title of the Cost Report
    filter string
    Filter query to apply to the Cost Report
    folderToken string
    Token of the folder this report resides in.
    savedFilterTokens string[]
    Saved filter tokens to be applied to the report.
    workspaceToken string
    Workspace token to add the cost report to.
    title str
    Title of the Cost Report
    filter str
    Filter query to apply to the Cost Report
    folder_token str
    Token of the folder this report resides in.
    saved_filter_tokens Sequence[str]
    Saved filter tokens to be applied to the report.
    workspace_token str
    Workspace token to add the cost report to.
    title String
    Title of the Cost Report
    filter String
    Filter query to apply to the Cost Report
    folderToken String
    Token of the folder this report resides in.
    savedFilterTokens List<String>
    Saved filter tokens to be applied to the 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,
            filter: Optional[str] = None,
            folder_token: Optional[str] = None,
            saved_filter_tokens: Optional[Sequence[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)
    Resource lookup is not supported in YAML
    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:
    Filter string
    Filter query to apply to the Cost Report
    FolderToken string
    Token of the folder this report resides in.
    SavedFilterTokens List<string>
    Saved filter tokens to be applied to the report.
    Title string
    Title of the Cost Report
    Token string
    Unique cost report identifier
    WorkspaceToken string
    Workspace token to add the cost report to.
    Filter string
    Filter query to apply to the Cost Report
    FolderToken string
    Token of the folder this report resides in.
    SavedFilterTokens []string
    Saved filter tokens to be applied to the report.
    Title string
    Title of the Cost Report
    Token string
    Unique cost report identifier
    WorkspaceToken string
    Workspace token to add the cost report to.
    filter String
    Filter query to apply to the Cost Report
    folderToken String
    Token of the folder this report resides in.
    savedFilterTokens List<String>
    Saved filter tokens to be applied to the report.
    title String
    Title of the Cost Report
    token String
    Unique cost report identifier
    workspaceToken String
    Workspace token to add the cost report to.
    filter string
    Filter query to apply to the Cost Report
    folderToken string
    Token of the folder this report resides in.
    savedFilterTokens string[]
    Saved filter tokens to be applied to the report.
    title string
    Title of the Cost Report
    token string
    Unique cost report identifier
    workspaceToken string
    Workspace token to add the cost report to.
    filter str
    Filter query to apply to the Cost Report
    folder_token str
    Token of the folder this report resides in.
    saved_filter_tokens Sequence[str]
    Saved filter tokens to be applied to the 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.
    filter String
    Filter query to apply to the Cost Report
    folderToken String
    Token of the folder this report resides in.
    savedFilterTokens List<String>
    Saved filter tokens to be applied to the 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 lbrlabs/pulumi-vantage
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage logo
    Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs