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

vantage.ScenarioModel

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",
        },
        {
            startAt: "2026-04-01",
            amount: 10,
            amountType: "percent",
        },
    ],
});

    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",
        },
        {
            "start_at": "2026-04-01",
            "amount": 10,
            "amount_type": "percent",
        },
    ])

    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.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"),
				},
				&vantage.ScenarioModelPeriodArgs{
					StartAt:    pulumi.String("2026-04-01"),
					Amount:     pulumi.Float64(10),
					AmountType: pulumi.String("percent"),
				},
			},
		})
		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",
            },
            new Vantage.Inputs.ScenarioModelPeriodArgs
            {
                StartAt = "2026-04-01",
                Amount = 10,
                AmountType = "percent",
            },
        },
    });

});

    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 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(),
                ScenarioModelPeriodArgs.builder()
                    .startAt("2026-04-01")
                    .amount(10.0)
                    .amountType("percent")
                    .build())
            .build());

    }
}

    resources:
  demo:
    type: vantage:ScenarioModel
    properties:
      title: Hiring Plan
      periods:
        - startAt: 2026-01-01
          endAt: 2026-03-31
          amount: 1250.75
          amountType: dollar
        - startAt: 2026-04-01
          amount: 10
          amountType: percent

    Example coming soon!

    Create ScenarioModel Resource

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

    Constructor syntax

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

@overload
def ScenarioModel(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  title: Optional[str] = None,
                  cloud_provider: Optional[str] = None,
                  periods: Optional[Sequence[ScenarioModelPeriodArgs]] = None,
                  priority: Optional[float] = None,
                  service: Optional[str] = None,
                  workspace_token: Optional[str] = None)
    func NewScenarioModel(ctx *Context, name string, args ScenarioModelArgs, opts ...ResourceOption) (*ScenarioModel, error)
    public ScenarioModel(string name, ScenarioModelArgs args, CustomResourceOptions? opts = null)
    public ScenarioModel(String name, ScenarioModelArgs args)
public ScenarioModel(String name, ScenarioModelArgs args, CustomResourceOptions options)

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


    resource "vantage_scenario_model" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ScenarioModelArgs
    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 ScenarioModelArgs
    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 ScenarioModelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScenarioModelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScenarioModelArgs
    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 scenarioModelResource = new Vantage.ScenarioModel("scenarioModelResource", new()
{
    Title = "string",
    CloudProvider = "string",
    Periods = new[]
    {
        new Vantage.Inputs.ScenarioModelPeriodArgs
        {
            Amount = 0,
            AmountType = "string",
            StartAt = "string",
            EndAt = "string",
        },
    },
    Priority = 0,
    Service = "string",
    WorkspaceToken = "string",
});

    example, err := vantage.NewScenarioModel(ctx, "scenarioModelResource", &vantage.ScenarioModelArgs{
	Title:         pulumi.String("string"),
	CloudProvider: pulumi.String("string"),
	Periods: vantage.ScenarioModelPeriodArray{
		&vantage.ScenarioModelPeriodArgs{
			Amount:     pulumi.Float64(0),
			AmountType: pulumi.String("string"),
			StartAt:    pulumi.String("string"),
			EndAt:      pulumi.String("string"),
		},
	},
	Priority:       pulumi.Float64(0),
	Service:        pulumi.String("string"),
	WorkspaceToken: pulumi.String("string"),
})

    resource "vantage_scenario_model" "scenarioModelResource" {
  lifecycle {
    create_before_destroy = true
  }
  title          = "string"
  cloud_provider = "string"
  periods {
    amount      = 0
    amount_type = "string"
    start_at    = "string"
    end_at      = "string"
  }
  priority        = 0
  service         = "string"
  workspace_token = "string"
}

    var scenarioModelResource = new ScenarioModel("scenarioModelResource", ScenarioModelArgs.builder()
    .title("string")
    .cloudProvider("string")
    .periods(ScenarioModelPeriodArgs.builder()
        .amount(0.0)
        .amountType("string")
        .startAt("string")
        .endAt("string")
        .build())
    .priority(0.0)
    .service("string")
    .workspaceToken("string")
    .build());

    scenario_model_resource = vantage.ScenarioModel("scenarioModelResource",
    title="string",
    cloud_provider="string",
    periods=[{
        "amount": float(0),
        "amount_type": "string",
        "start_at": "string",
        "end_at": "string",
    }],
    priority=float(0),
    service="string",
    workspace_token="string")

    const scenarioModelResource = new vantage.ScenarioModel("scenarioModelResource", {
    title: "string",
    cloudProvider: "string",
    periods: [{
        amount: 0,
        amountType: "string",
        startAt: "string",
        endAt: "string",
    }],
    priority: 0,
    service: "string",
    workspaceToken: "string",
});

    type: vantage:ScenarioModel
properties:
    cloudProvider: string
    periods:
        - amount: 0
          amountType: string
          endAt: string
          startAt: string
    priority: 0
    service: string
    title: string
    workspaceToken: string

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

    Title string
    CloudProvider string
    The cloud provider filter for the ScenarioModel.
    Periods List<ScenarioModelPeriod>
    The periods for the ScenarioModel.
    Priority double
    Service string
    WorkspaceToken string
    Title string
    CloudProvider string
    The cloud provider filter for the ScenarioModel.
    Periods []ScenarioModelPeriodArgs
    The periods for the ScenarioModel.
    Priority float64
    Service string
    WorkspaceToken string
    title string
    cloud_provider string
    The cloud provider filter for the ScenarioModel.
    periods list(object)
    The periods for the ScenarioModel.
    priority number
    service string
    workspace_token string
    title String
    cloudProvider String
    The cloud provider filter for the ScenarioModel.
    periods List<ScenarioModelPeriod>
    The periods for the ScenarioModel.
    priority Double
    service String
    workspaceToken String
    title string
    cloudProvider string
    The cloud provider filter for the ScenarioModel.
    periods ScenarioModelPeriod[]
    The periods for the ScenarioModel.
    priority number
    service string
    workspaceToken string
    title str
    cloud_provider str
    The cloud provider filter for the ScenarioModel.
    periods Sequence[ScenarioModelPeriodArgs]
    The periods for the ScenarioModel.
    priority float
    service str
    workspace_token str
    title String
    cloudProvider String
    The cloud provider filter for the ScenarioModel.
    periods List<Property Map>
    The periods for the ScenarioModel.
    priority Number
    service String
    workspaceToken String

    Outputs

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

    CreatedAt string
    CreatedByToken string
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the scenario model
    UpdatedAt string
    CreatedAt string
    CreatedByToken string
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the scenario model
    UpdatedAt string
    created_at string
    created_by_token string
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the scenario model
    updated_at string
    createdAt String
    createdByToken String
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the scenario model
    updatedAt String
    createdAt string
    createdByToken string
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the scenario model
    updatedAt string
    created_at str
    created_by_token str
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token of the scenario model
    updated_at str
    createdAt String
    createdByToken String
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the scenario model
    updatedAt String

    Look up Existing ScenarioModel Resource

    Get an existing ScenarioModel 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?: ScenarioModelState, opts?: CustomResourceOptions): ScenarioModel
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_provider: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by_token: Optional[str] = None,
        periods: Optional[Sequence[ScenarioModelPeriodArgs]] = None,
        priority: Optional[float] = None,
        service: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        updated_at: Optional[str] = None,
        workspace_token: Optional[str] = None) -> ScenarioModel
    func GetScenarioModel(ctx *Context, name string, id IDInput, state *ScenarioModelState, opts ...ResourceOption) (*ScenarioModel, error)
    public static ScenarioModel Get(string name, Input<string> id, ScenarioModelState? state, CustomResourceOptions? opts = null)
    public static ScenarioModel get(String name, Output<String> id, ScenarioModelState state, CustomResourceOptions options)
    resources:  _:    type: vantage:ScenarioModel    get:      id: ${id}
    import {
  to = vantage_scenario_model.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:
    CloudProvider string
    The cloud provider filter for the ScenarioModel.
    CreatedAt string
    CreatedByToken string
    Periods List<ScenarioModelPeriod>
    The periods for the ScenarioModel.
    Priority double
    Service string
    Title string
    Token string
    The token of the scenario model
    UpdatedAt string
    WorkspaceToken string
    CloudProvider string
    The cloud provider filter for the ScenarioModel.
    CreatedAt string
    CreatedByToken string
    Periods []ScenarioModelPeriodArgs
    The periods for the ScenarioModel.
    Priority float64
    Service string
    Title string
    Token string
    The token of the scenario model
    UpdatedAt string
    WorkspaceToken string
    cloud_provider string
    The cloud provider filter for the ScenarioModel.
    created_at string
    created_by_token string
    periods list(object)
    The periods for the ScenarioModel.
    priority number
    service string
    title string
    token string
    The token of the scenario model
    updated_at string
    workspace_token string
    cloudProvider String
    The cloud provider filter for the ScenarioModel.
    createdAt String
    createdByToken String
    periods List<ScenarioModelPeriod>
    The periods for the ScenarioModel.
    priority Double
    service String
    title String
    token String
    The token of the scenario model
    updatedAt String
    workspaceToken String
    cloudProvider string
    The cloud provider filter for the ScenarioModel.
    createdAt string
    createdByToken string
    periods ScenarioModelPeriod[]
    The periods for the ScenarioModel.
    priority number
    service string
    title string
    token string
    The token of the scenario model
    updatedAt string
    workspaceToken string
    cloud_provider str
    The cloud provider filter for the ScenarioModel.
    created_at str
    created_by_token str
    periods Sequence[ScenarioModelPeriodArgs]
    The periods for the ScenarioModel.
    priority float
    service str
    title str
    token str
    The token of the scenario model
    updated_at str
    workspace_token str
    cloudProvider String
    The cloud provider filter for the ScenarioModel.
    createdAt String
    createdByToken String
    periods List<Property Map>
    The periods for the ScenarioModel.
    priority Number
    service String
    title String
    token String
    The token of the scenario model
    updatedAt String
    workspaceToken String

    Supporting Types

    ScenarioModelPeriod, ScenarioModelPeriodArgs

    Amount double
    AmountType string
    Whether the amount is in dollars or percent.
    StartAt string
    The ISO 8601 start date of the period.
    EndAt string
    The ISO 8601 end date of the period.
    Amount float64
    AmountType string
    Whether the amount is in dollars or percent.
    StartAt string
    The ISO 8601 start date of the period.
    EndAt string
    The ISO 8601 end date of the period.
    amount number
    amount_type string
    Whether the amount is in dollars or percent.
    start_at string
    The ISO 8601 start date of the period.
    end_at string
    The ISO 8601 end date of the period.
    amount Double
    amountType String
    Whether the amount is in dollars or percent.
    startAt String
    The ISO 8601 start date of the period.
    endAt String
    The ISO 8601 end date of the period.
    amount number
    amountType string
    Whether the amount is in dollars or percent.
    startAt string
    The ISO 8601 start date of the period.
    endAt string
    The ISO 8601 end date of the period.
    amount float
    amount_type str
    Whether the amount is in dollars or percent.
    start_at str
    The ISO 8601 start date of the period.
    end_at str
    The ISO 8601 end date of the period.
    amount Number
    amountType String
    Whether the amount is in dollars or percent.
    startAt String
    The ISO 8601 start date of the period.
    endAt String
    The ISO 8601 end date of the period.

    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