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

vantage.ReportForecast

Viewing docs for vantage 0.3.17
published on Monday, Aug 17, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

    Example Usage

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

const demo = new vantage.ScenarioModel("demo", {
    title: "Hiring Plan",
    periods: [{
        startAt: "2026-01-01",
        endAt: "2026-03-31",
        amount: 1250.75,
        amountType: "dollar",
    }],
});
const demoReportForecast = new vantage.ReportForecast("demo", {
    title: "Board Plan",
    costReportToken: demoReport.token,
    scenarioModelTokens: [demo.token],
    setAsDefault: true,
});

    import pulumi
import pulumi_vantage as vantage

demo = vantage.ScenarioModel("demo",
    title="Hiring Plan",
    periods=[{
        "start_at": "2026-01-01",
        "end_at": "2026-03-31",
        "amount": 1250.75,
        "amount_type": "dollar",
    }])
demo_report_forecast = vantage.ReportForecast("demo",
    title="Board Plan",
    cost_report_token=demo_report["token"],
    scenario_model_tokens=[demo.token],
    set_as_default=True)

    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 {
		demo, err := vantage.NewScenarioModel(ctx, "demo", &vantage.ScenarioModelArgs{
			Title: pulumi.String("Hiring Plan"),
			Periods: vantage.ScenarioModelPeriodArray{
				&vantage.ScenarioModelPeriodArgs{
					StartAt:    pulumi.String("2026-01-01"),
					EndAt:      pulumi.String("2026-03-31"),
					Amount:     pulumi.Float64(1250.75),
					AmountType: pulumi.String("dollar"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = vantage.NewReportForecast(ctx, "demo", &vantage.ReportForecastArgs{
			Title:           pulumi.String("Board Plan"),
			CostReportToken: pulumi.Any(demoReport.Token),
			ScenarioModelTokens: pulumi.StringArray{
				demo.Token,
			},
			SetAsDefault: pulumi.Bool(true),
		})
		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 demo = new Vantage.ScenarioModel("demo", new()
    {
        Title = "Hiring Plan",
        Periods = new[]
        {
            new Vantage.Inputs.ScenarioModelPeriodArgs
            {
                StartAt = "2026-01-01",
                EndAt = "2026-03-31",
                Amount = 1250.75,
                AmountType = "dollar",
            },
        },
    });

    var demoReportForecast = new Vantage.ReportForecast("demo", new()
    {
        Title = "Board Plan",
        CostReportToken = demoReport.Token,
        ScenarioModelTokens = new[]
        {
            demo.Token,
        },
        SetAsDefault = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vantage.ScenarioModel;
import com.pulumi.vantage.ScenarioModelArgs;
import com.pulumi.vantage.inputs.ScenarioModelPeriodArgs;
import com.pulumi.vantage.ReportForecast;
import com.pulumi.vantage.ReportForecastArgs;
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 demo = new ScenarioModel("demo", ScenarioModelArgs.builder()
            .title("Hiring Plan")
            .periods(ScenarioModelPeriodArgs.builder()
                .startAt("2026-01-01")
                .endAt("2026-03-31")
                .amount(1250.75)
                .amountType("dollar")
                .build())
            .build());

        var demoReportForecast = new ReportForecast("demoReportForecast", ReportForecastArgs.builder()
            .title("Board Plan")
            .costReportToken(demoReport.token())
            .scenarioModelTokens(demo.token())
            .setAsDefault(true)
            .build());

    }
}

    resources:
  demo:
    type: vantage:ScenarioModel
    properties:
      title: Hiring Plan
      periods:
        - startAt: 2026-01-01
          endAt: 2026-03-31
          amount: 1250.75
          amountType: dollar
  demoReportForecast:
    type: vantage:ReportForecast
    name: demo
    properties:
      title: Board Plan
      costReportToken: ${demoReport.token}
      scenarioModelTokens:
        - ${demo.token}
      setAsDefault: true

    Example coming soon!

    Create ReportForecast Resource

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

    Constructor syntax

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

@overload
def ReportForecast(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cost_report_token: Optional[str] = None,
                   title: Optional[str] = None,
                   business_metric_token: Optional[str] = None,
                   scenario_model_tokens: Optional[Sequence[str]] = None,
                   set_as_default: Optional[bool] = None)
    func NewReportForecast(ctx *Context, name string, args ReportForecastArgs, opts ...ResourceOption) (*ReportForecast, error)
    public ReportForecast(string name, ReportForecastArgs args, CustomResourceOptions? opts = null)
    public ReportForecast(String name, ReportForecastArgs args)
public ReportForecast(String name, ReportForecastArgs args, CustomResourceOptions options)

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


    resource "vantage_report_forecast" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ReportForecastArgs
    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 ReportForecastArgs
    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 ReportForecastArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReportForecastArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReportForecastArgs
    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 reportForecastResource = new Vantage.ReportForecast("reportForecastResource", new()
{
    CostReportToken = "string",
    Title = "string",
    BusinessMetricToken = "string",
    ScenarioModelTokens = new[]
    {
        "string",
    },
    SetAsDefault = false,
});

    example, err := vantage.NewReportForecast(ctx, "reportForecastResource", &vantage.ReportForecastArgs{
	CostReportToken:     pulumi.String("string"),
	Title:               pulumi.String("string"),
	BusinessMetricToken: pulumi.String("string"),
	ScenarioModelTokens: pulumi.StringArray{
		pulumi.String("string"),
	},
	SetAsDefault: pulumi.Bool(false),
})

    resource "vantage_report_forecast" "reportForecastResource" {
  lifecycle {
    create_before_destroy = true
  }
  cost_report_token     = "string"
  title                 = "string"
  business_metric_token = "string"
  scenario_model_tokens = ["string"]
  set_as_default        = false
}

    var reportForecastResource = new ReportForecast("reportForecastResource", ReportForecastArgs.builder()
    .costReportToken("string")
    .title("string")
    .businessMetricToken("string")
    .scenarioModelTokens("string")
    .setAsDefault(false)
    .build());

    report_forecast_resource = vantage.ReportForecast("reportForecastResource",
    cost_report_token="string",
    title="string",
    business_metric_token="string",
    scenario_model_tokens=["string"],
    set_as_default=False)

    const reportForecastResource = new vantage.ReportForecast("reportForecastResource", {
    costReportToken: "string",
    title: "string",
    businessMetricToken: "string",
    scenarioModelTokens: ["string"],
    setAsDefault: false,
});

    type: vantage:ReportForecast
properties:
    businessMetricToken: string
    costReportToken: string
    scenarioModelTokens:
        - string
    setAsDefault: false
    title: string

    ReportForecast 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 ReportForecast resource accepts the following input properties:

    Outputs

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

    CreatedAt string
    CreatedByToken string
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Token string
    The token of the report forecast
    UpdatedAt string
    CreatedAt string
    CreatedByToken string
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Token string
    The token of the report forecast
    UpdatedAt string
    created_at string
    created_by_token string
    id string
    The provider-assigned unique ID for this managed resource.
    is_default bool
    token string
    The token of the report forecast
    updated_at string
    createdAt String
    createdByToken String
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    token String
    The token of the report forecast
    updatedAt String
    createdAt string
    createdByToken string
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    token string
    The token of the report forecast
    updatedAt string
    created_at str
    created_by_token str
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    token str
    The token of the report forecast
    updated_at str
    createdAt String
    createdByToken String
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    token String
    The token of the report forecast
    updatedAt String

    Look up Existing ReportForecast Resource

    Get an existing ReportForecast 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?: ReportForecastState, opts?: CustomResourceOptions): ReportForecast
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        business_metric_token: Optional[str] = None,
        cost_report_token: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by_token: Optional[str] = None,
        is_default: Optional[bool] = None,
        scenario_model_tokens: Optional[Sequence[str]] = None,
        set_as_default: Optional[bool] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        updated_at: Optional[str] = None) -> ReportForecast
    func GetReportForecast(ctx *Context, name string, id IDInput, state *ReportForecastState, opts ...ResourceOption) (*ReportForecast, error)
    public static ReportForecast Get(string name, Input<string> id, ReportForecastState? state, CustomResourceOptions? opts = null)
    public static ReportForecast get(String name, Output<String> id, ReportForecastState state, CustomResourceOptions options)
    resources:  _:    type: vantage:ReportForecast    get:      id: ${id}
    import {
  to = vantage_report_forecast.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:
    BusinessMetricToken string
    CostReportToken string
    CreatedAt string
    CreatedByToken string
    IsDefault bool
    ScenarioModelTokens List<string>
    SetAsDefault bool
    Title string
    Token string
    The token of the report forecast
    UpdatedAt string
    BusinessMetricToken string
    CostReportToken string
    CreatedAt string
    CreatedByToken string
    IsDefault bool
    ScenarioModelTokens []string
    SetAsDefault bool
    Title string
    Token string
    The token of the report forecast
    UpdatedAt string
    business_metric_token string
    cost_report_token string
    created_at string
    created_by_token string
    is_default bool
    scenario_model_tokens list(string)
    set_as_default bool
    title string
    token string
    The token of the report forecast
    updated_at string
    businessMetricToken String
    costReportToken String
    createdAt String
    createdByToken String
    isDefault Boolean
    scenarioModelTokens List<String>
    setAsDefault Boolean
    title String
    token String
    The token of the report forecast
    updatedAt String
    businessMetricToken string
    costReportToken string
    createdAt string
    createdByToken string
    isDefault boolean
    scenarioModelTokens string[]
    setAsDefault boolean
    title string
    token string
    The token of the report forecast
    updatedAt string
    businessMetricToken String
    costReportToken String
    createdAt String
    createdByToken String
    isDefault Boolean
    scenarioModelTokens List<String>
    setAsDefault Boolean
    title String
    token String
    The token of the report forecast
    updatedAt String

    Package Details

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial