> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vantage.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# vantage_scenario_model (Resource)

> Terraform resource reference for vantage_scenario_model (Resource). Auto-generated from the vantage-sh/terraform-provider-vantage repository.

<Note>
  This page is auto-generated based on the official [Terraform documentation](https://registry.terraform.io/providers/vantage-sh/vantage/latest/docs).
</Note>

## Overview

Use this resource with the [Vantage Terraform provider](/terraform). For installation and authentication, see the [Terraform provider quickstart](/terraform#quickstart). The schema below is generated directly from the provider source.

## Example Usage

```terraform theme={null}
resource "vantage_scenario_model" "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"
    }
  ]
}
```

## Schema

### Required

* `title` (String)

### Optional

* `cloud_provider` (String) The cloud provider filter for the ScenarioModel.
* `periods` (Attributes List) The periods for the ScenarioModel. (see [below for nested schema](#nestedatt--periods))
* `priority` (Number)
* `service` (String)
* `workspace_token` (String)

### Read-Only

* `created_at` (String)
* `created_by_token` (String)
* `id` (String) The id of the scenario model
* `token` (String) The token of the scenario model
* `updated_at` (String)

<a id="nestedatt--periods" />

### Nested Schema for `periods`

Required:

* `amount` (Number)
* `amount_type` (String) Whether the amount is in dollars or percent.
* `start_at` (String) The ISO 8601 start date of the period.

Optional:

* `end_at` (String) The ISO 8601 end date of the period.