Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Vantage Provider
  4. API Docs
  5. Canvas
Viewing docs for vantage 0.3.11
published on Friday, Jul 24, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

vantage.Canvas

Viewing docs for vantage 0.3.11
published on Friday, Jul 24, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

    Manages a Canvas.

    Create Canvas Resource

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

    Constructor syntax

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

@overload
def Canvas(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           prompt: Optional[str] = None,
           title: Optional[str] = None,
           workspace_token: Optional[str] = None)
    func NewCanvas(ctx *Context, name string, args CanvasArgs, opts ...ResourceOption) (*Canvas, error)
    public Canvas(string name, CanvasArgs args, CustomResourceOptions? opts = null)
    public Canvas(String name, CanvasArgs args)
public Canvas(String name, CanvasArgs args, CustomResourceOptions options)

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


    resource "vantage_canvas" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CanvasArgs
    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 CanvasArgs
    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 CanvasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CanvasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CanvasArgs
    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 canvasResource = new Vantage.Canvas("canvasResource", new()
{
    Prompt = "string",
    Title = "string",
    WorkspaceToken = "string",
});

    example, err := vantage.NewCanvas(ctx, "canvasResource", &vantage.CanvasArgs{
	Prompt:         pulumi.String("string"),
	Title:          pulumi.String("string"),
	WorkspaceToken: pulumi.String("string"),
})

    resource "vantage_canvas" "canvasResource" {
  lifecycle {
    create_before_destroy = true
  }
  prompt          = "string"
  title           = "string"
  workspace_token = "string"
}

    var canvasResource = new Canvas("canvasResource", CanvasArgs.builder()
    .prompt("string")
    .title("string")
    .workspaceToken("string")
    .build());

    canvas_resource = vantage.Canvas("canvasResource",
    prompt="string",
    title="string",
    workspace_token="string")

    const canvasResource = new vantage.Canvas("canvasResource", {
    prompt: "string",
    title: "string",
    workspaceToken: "string",
});

    type: vantage:Canvas
properties:
    prompt: string
    title: string
    workspaceToken: string

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

    Prompt string
    The prompt used to generate the Canvas.
    Title string
    The title of the Canvas.
    WorkspaceToken string
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    Prompt string
    The prompt used to generate the Canvas.
    Title string
    The title of the Canvas.
    WorkspaceToken string
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    prompt string
    The prompt used to generate the Canvas.
    title string
    The title of the Canvas.
    workspace_token string
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    prompt String
    The prompt used to generate the Canvas.
    title String
    The title of the Canvas.
    workspaceToken String
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    prompt string
    The prompt used to generate the Canvas.
    title string
    The title of the Canvas.
    workspaceToken string
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    prompt str
    The prompt used to generate the Canvas.
    title str
    The title of the Canvas.
    workspace_token str
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    prompt String
    The prompt used to generate the Canvas.
    title String
    The title of the Canvas.
    workspaceToken String
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.

    Outputs

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

    CreatedAt string
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    Data CanvasData
    The structured table data of the Canvas.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the canvas
    UpdatedAt string
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    CreatedAt string
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    Data CanvasData
    The structured table data of the Canvas.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token of the canvas
    UpdatedAt string
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    created_at string
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data object
    The structured table data of the Canvas.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the canvas
    updated_at string
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    createdAt String
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data CanvasData
    The structured table data of the Canvas.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the canvas
    updatedAt String
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    createdAt string
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data CanvasData
    The structured table data of the Canvas.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token of the canvas
    updatedAt string
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    created_at str
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data CanvasData
    The structured table data of the Canvas.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token of the canvas
    updated_at str
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    createdAt String
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data Property Map
    The structured table data of the Canvas.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token of the canvas
    updatedAt String
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.

    Look up Existing Canvas Resource

    Get an existing Canvas 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?: CanvasState, opts?: CustomResourceOptions): Canvas
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        data: Optional[CanvasDataArgs] = None,
        prompt: Optional[str] = None,
        title: Optional[str] = None,
        token: Optional[str] = None,
        updated_at: Optional[str] = None,
        workspace_token: Optional[str] = None) -> Canvas
    func GetCanvas(ctx *Context, name string, id IDInput, state *CanvasState, opts ...ResourceOption) (*Canvas, error)
    public static Canvas Get(string name, Input<string> id, CanvasState? state, CustomResourceOptions? opts = null)
    public static Canvas get(String name, Output<String> id, CanvasState state, CustomResourceOptions options)
    resources:  _:    type: vantage:Canvas    get:      id: ${id}
    import {
  to = vantage_canvas.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:
    CreatedAt string
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    Data CanvasData
    The structured table data of the Canvas.
    Prompt string
    The prompt used to generate the Canvas.
    Title string
    The title of the Canvas.
    Token string
    The token of the canvas
    UpdatedAt string
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    WorkspaceToken string
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    CreatedAt string
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    Data CanvasDataArgs
    The structured table data of the Canvas.
    Prompt string
    The prompt used to generate the Canvas.
    Title string
    The title of the Canvas.
    Token string
    The token of the canvas
    UpdatedAt string
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    WorkspaceToken string
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    created_at string
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data object
    The structured table data of the Canvas.
    prompt string
    The prompt used to generate the Canvas.
    title string
    The title of the Canvas.
    token string
    The token of the canvas
    updated_at string
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    workspace_token string
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    createdAt String
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data CanvasData
    The structured table data of the Canvas.
    prompt String
    The prompt used to generate the Canvas.
    title String
    The title of the Canvas.
    token String
    The token of the canvas
    updatedAt String
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    workspaceToken String
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    createdAt string
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data CanvasData
    The structured table data of the Canvas.
    prompt string
    The prompt used to generate the Canvas.
    title string
    The title of the Canvas.
    token string
    The token of the canvas
    updatedAt string
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    workspaceToken string
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    created_at str
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data CanvasDataArgs
    The structured table data of the Canvas.
    prompt str
    The prompt used to generate the Canvas.
    title str
    The title of the Canvas.
    token str
    The token of the canvas
    updated_at str
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    workspace_token str
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.
    createdAt String
    The date and time, in UTC, the Canvas was created. ISO 8601 Formatted.
    data Property Map
    The structured table data of the Canvas.
    prompt String
    The prompt used to generate the Canvas.
    title String
    The title of the Canvas.
    token String
    The token of the canvas
    updatedAt String
    The date and time, in UTC, the Canvas was last updated. ISO 8601 Formatted.
    workspaceToken String
    The token of the Workspace to add the Canvas to. Required if the API token is associated with multiple Workspaces.

    Supporting Types

    CanvasData, CanvasDataArgs

    Error string
    Error message if the refresh workflow failed.
    Table string
    JSON-encoded tabular data produced by the Canvas refresh workflow.
    Error string
    Error message if the refresh workflow failed.
    Table string
    JSON-encoded tabular data produced by the Canvas refresh workflow.
    error string
    Error message if the refresh workflow failed.
    table string
    JSON-encoded tabular data produced by the Canvas refresh workflow.
    error String
    Error message if the refresh workflow failed.
    table String
    JSON-encoded tabular data produced by the Canvas refresh workflow.
    error string
    Error message if the refresh workflow failed.
    table string
    JSON-encoded tabular data produced by the Canvas refresh workflow.
    error str
    Error message if the refresh workflow failed.
    table str
    JSON-encoded tabular data produced by the Canvas refresh workflow.
    error String
    Error message if the refresh workflow failed.
    table String
    JSON-encoded tabular data produced by the Canvas refresh workflow.

    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.11
    published on Friday, Jul 24, 2026 by vantage-sh
    Schema (JSON)
    vantage-sh/terraform-provider-vantage

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial