Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. vmp
  5. Workspace
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.vmp.Workspace

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage vmp workspace

    Example Usage

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

const foo = new volcengine.vmp.Workspace("foo", {
    deleteProtectionEnabled: false,
    description: "acc-test",
    instanceTypeId: "vmp.standard.15d",
    password: "Pass123456",
    projectName: "default",
    tags: [{
        key: "k1",
        value: "v1",
    }],
    username: "admin123",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.vmp.Workspace("foo",
    delete_protection_enabled=False,
    description="acc-test",
    instance_type_id="vmp.standard.15d",
    password="Pass123456",
    project_name="default",
    tags=[volcengine.vmp.WorkspaceTagArgs(
        key="k1",
        value="v1",
    )],
    username="admin123")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vmp"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vmp.NewWorkspace(ctx, "foo", &vmp.WorkspaceArgs{
			DeleteProtectionEnabled: pulumi.Bool(false),
			Description:             pulumi.String("acc-test"),
			InstanceTypeId:          pulumi.String("vmp.standard.15d"),
			Password:                pulumi.String("Pass123456"),
			ProjectName:             pulumi.String("default"),
			Tags: vmp.WorkspaceTagArray{
				&vmp.WorkspaceTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
			Username: pulumi.String("admin123"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Vmp.Workspace("foo", new()
    {
        DeleteProtectionEnabled = false,
        Description = "acc-test",
        InstanceTypeId = "vmp.standard.15d",
        Password = "Pass123456",
        ProjectName = "default",
        Tags = new[]
        {
            new Volcengine.Vmp.Inputs.WorkspaceTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
        Username = "admin123",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.vmp.Workspace;
import com.pulumi.volcengine.vmp.WorkspaceArgs;
import com.pulumi.volcengine.vmp.inputs.WorkspaceTagArgs;
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 foo = new Workspace("foo", WorkspaceArgs.builder()        
            .deleteProtectionEnabled(false)
            .description("acc-test")
            .instanceTypeId("vmp.standard.15d")
            .password("Pass123456")
            .projectName("default")
            .tags(WorkspaceTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .username("admin123")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:vmp:Workspace
    properties:
      deleteProtectionEnabled: false
      description: acc-test
      instanceTypeId: vmp.standard.15d
      password: Pass123456
      projectName: default
      tags:
        - key: k1
          value: v1
      username: admin123

    Create Workspace Resource

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

    Constructor syntax

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

@overload
def Workspace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              instance_type_id: Optional[str] = None,
              delete_protection_enabled: Optional[bool] = None,
              description: Optional[str] = None,
              name: Optional[str] = None,
              password: Optional[str] = None,
              project_name: Optional[str] = None,
              tags: Optional[Sequence[WorkspaceTagArgs]] = None,
              username: Optional[str] = None)
    func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)
    public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)
    public Workspace(String name, WorkspaceArgs args)
public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)

    type: volcengine:vmp:Workspace
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 WorkspaceArgs
    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 WorkspaceArgs
    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 WorkspaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkspaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkspaceArgs
    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 volcengineWorkspaceResource = new Volcengine.Vmp.Workspace("volcengineWorkspaceResource", new()
{
    InstanceTypeId = "string",
    DeleteProtectionEnabled = false,
    Description = "string",
    Name = "string",
    Password = "string",
    ProjectName = "string",
    Tags = new[]
    {
        new Volcengine.Vmp.Inputs.WorkspaceTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    Username = "string",
});

    example, err := vmp.NewWorkspace(ctx, "volcengineWorkspaceResource", &vmp.WorkspaceArgs{
	InstanceTypeId:          pulumi.String("string"),
	DeleteProtectionEnabled: pulumi.Bool(false),
	Description:             pulumi.String("string"),
	Name:                    pulumi.String("string"),
	Password:                pulumi.String("string"),
	ProjectName:             pulumi.String("string"),
	Tags: vmp.WorkspaceTagArray{
		&vmp.WorkspaceTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Username: pulumi.String("string"),
})

    var volcengineWorkspaceResource = new com.pulumi.volcengine.vmp.Workspace("volcengineWorkspaceResource", com.pulumi.volcengine.vmp.WorkspaceArgs.builder()
    .instanceTypeId("string")
    .deleteProtectionEnabled(false)
    .description("string")
    .name("string")
    .password("string")
    .projectName("string")
    .tags(WorkspaceTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .username("string")
    .build());

    volcengine_workspace_resource = volcengine.vmp.Workspace("volcengineWorkspaceResource",
    instance_type_id="string",
    delete_protection_enabled=False,
    description="string",
    name="string",
    password="string",
    project_name="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    username="string")

    const volcengineWorkspaceResource = new volcengine.vmp.Workspace("volcengineWorkspaceResource", {
    instanceTypeId: "string",
    deleteProtectionEnabled: false,
    description: "string",
    name: "string",
    password: "string",
    projectName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    username: "string",
});

    type: volcengine:vmp:Workspace
properties:
    deleteProtectionEnabled: false
    description: string
    instanceTypeId: string
    name: string
    password: string
    projectName: string
    tags:
        - key: string
          value: string
    username: string

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

    InstanceTypeId string
    The instance type id of the workspace.
    DeleteProtectionEnabled bool
    Whether enable delete protection.
    Description string
    The description of the workspace.
    Name string
    The name of the workspace.
    Password string
    The password of the workspace.
    ProjectName string
    The project name of the vmp workspace.
    Tags List<WorkspaceTag>
    Tags.
    Username string
    The username of the workspace.
    InstanceTypeId string
    The instance type id of the workspace.
    DeleteProtectionEnabled bool
    Whether enable delete protection.
    Description string
    The description of the workspace.
    Name string
    The name of the workspace.
    Password string
    The password of the workspace.
    ProjectName string
    The project name of the vmp workspace.
    Tags []WorkspaceTagArgs
    Tags.
    Username string
    The username of the workspace.
    instanceTypeId String
    The instance type id of the workspace.
    deleteProtectionEnabled Boolean
    Whether enable delete protection.
    description String
    The description of the workspace.
    name String
    The name of the workspace.
    password String
    The password of the workspace.
    projectName String
    The project name of the vmp workspace.
    tags List<WorkspaceTag>
    Tags.
    username String
    The username of the workspace.
    instanceTypeId string
    The instance type id of the workspace.
    deleteProtectionEnabled boolean
    Whether enable delete protection.
    description string
    The description of the workspace.
    name string
    The name of the workspace.
    password string
    The password of the workspace.
    projectName string
    The project name of the vmp workspace.
    tags WorkspaceTag[]
    Tags.
    username string
    The username of the workspace.
    instance_type_id str
    The instance type id of the workspace.
    delete_protection_enabled bool
    Whether enable delete protection.
    description str
    The description of the workspace.
    name str
    The name of the workspace.
    password str
    The password of the workspace.
    project_name str
    The project name of the vmp workspace.
    tags Sequence[WorkspaceTagArgs]
    Tags.
    username str
    The username of the workspace.
    instanceTypeId String
    The instance type id of the workspace.
    deleteProtectionEnabled Boolean
    Whether enable delete protection.
    description String
    The description of the workspace.
    name String
    The name of the workspace.
    password String
    The password of the workspace.
    projectName String
    The project name of the vmp workspace.
    tags List<Property Map>
    Tags.
    username String
    The username of the workspace.

    Outputs

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

    CreateTime string
    The create time of workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    OverdueReclaimTime string
    The overdue reclaim time.
    PrometheusPushIntranetEndpoint string
    The prometheus push intranet endpoint.
    PrometheusQueryIntranetEndpoint string
    The prometheus query intranet endpoint.
    PrometheusWriteIntranetEndpoint string
    The prometheus write intranet endpoint.
    Status string
    The status of workspace.
    CreateTime string
    The create time of workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    OverdueReclaimTime string
    The overdue reclaim time.
    PrometheusPushIntranetEndpoint string
    The prometheus push intranet endpoint.
    PrometheusQueryIntranetEndpoint string
    The prometheus query intranet endpoint.
    PrometheusWriteIntranetEndpoint string
    The prometheus write intranet endpoint.
    Status string
    The status of workspace.
    createTime String
    The create time of workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    overdueReclaimTime String
    The overdue reclaim time.
    prometheusPushIntranetEndpoint String
    The prometheus push intranet endpoint.
    prometheusQueryIntranetEndpoint String
    The prometheus query intranet endpoint.
    prometheusWriteIntranetEndpoint String
    The prometheus write intranet endpoint.
    status String
    The status of workspace.
    createTime string
    The create time of workspace.
    id string
    The provider-assigned unique ID for this managed resource.
    overdueReclaimTime string
    The overdue reclaim time.
    prometheusPushIntranetEndpoint string
    The prometheus push intranet endpoint.
    prometheusQueryIntranetEndpoint string
    The prometheus query intranet endpoint.
    prometheusWriteIntranetEndpoint string
    The prometheus write intranet endpoint.
    status string
    The status of workspace.
    create_time str
    The create time of workspace.
    id str
    The provider-assigned unique ID for this managed resource.
    overdue_reclaim_time str
    The overdue reclaim time.
    prometheus_push_intranet_endpoint str
    The prometheus push intranet endpoint.
    prometheus_query_intranet_endpoint str
    The prometheus query intranet endpoint.
    prometheus_write_intranet_endpoint str
    The prometheus write intranet endpoint.
    status str
    The status of workspace.
    createTime String
    The create time of workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    overdueReclaimTime String
    The overdue reclaim time.
    prometheusPushIntranetEndpoint String
    The prometheus push intranet endpoint.
    prometheusQueryIntranetEndpoint String
    The prometheus query intranet endpoint.
    prometheusWriteIntranetEndpoint String
    The prometheus write intranet endpoint.
    status String
    The status of workspace.

    Look up Existing Workspace Resource

    Get an existing Workspace 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?: WorkspaceState, opts?: CustomResourceOptions): Workspace
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        delete_protection_enabled: Optional[bool] = None,
        description: Optional[str] = None,
        instance_type_id: Optional[str] = None,
        name: Optional[str] = None,
        overdue_reclaim_time: Optional[str] = None,
        password: Optional[str] = None,
        project_name: Optional[str] = None,
        prometheus_push_intranet_endpoint: Optional[str] = None,
        prometheus_query_intranet_endpoint: Optional[str] = None,
        prometheus_write_intranet_endpoint: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[WorkspaceTagArgs]] = None,
        username: Optional[str] = None) -> Workspace
    func GetWorkspace(ctx *Context, name string, id IDInput, state *WorkspaceState, opts ...ResourceOption) (*Workspace, error)
    public static Workspace Get(string name, Input<string> id, WorkspaceState? state, CustomResourceOptions? opts = null)
    public static Workspace get(String name, Output<String> id, WorkspaceState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:vmp:Workspace    get:      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:
    CreateTime string
    The create time of workspace.
    DeleteProtectionEnabled bool
    Whether enable delete protection.
    Description string
    The description of the workspace.
    InstanceTypeId string
    The instance type id of the workspace.
    Name string
    The name of the workspace.
    OverdueReclaimTime string
    The overdue reclaim time.
    Password string
    The password of the workspace.
    ProjectName string
    The project name of the vmp workspace.
    PrometheusPushIntranetEndpoint string
    The prometheus push intranet endpoint.
    PrometheusQueryIntranetEndpoint string
    The prometheus query intranet endpoint.
    PrometheusWriteIntranetEndpoint string
    The prometheus write intranet endpoint.
    Status string
    The status of workspace.
    Tags List<WorkspaceTag>
    Tags.
    Username string
    The username of the workspace.
    CreateTime string
    The create time of workspace.
    DeleteProtectionEnabled bool
    Whether enable delete protection.
    Description string
    The description of the workspace.
    InstanceTypeId string
    The instance type id of the workspace.
    Name string
    The name of the workspace.
    OverdueReclaimTime string
    The overdue reclaim time.
    Password string
    The password of the workspace.
    ProjectName string
    The project name of the vmp workspace.
    PrometheusPushIntranetEndpoint string
    The prometheus push intranet endpoint.
    PrometheusQueryIntranetEndpoint string
    The prometheus query intranet endpoint.
    PrometheusWriteIntranetEndpoint string
    The prometheus write intranet endpoint.
    Status string
    The status of workspace.
    Tags []WorkspaceTagArgs
    Tags.
    Username string
    The username of the workspace.
    createTime String
    The create time of workspace.
    deleteProtectionEnabled Boolean
    Whether enable delete protection.
    description String
    The description of the workspace.
    instanceTypeId String
    The instance type id of the workspace.
    name String
    The name of the workspace.
    overdueReclaimTime String
    The overdue reclaim time.
    password String
    The password of the workspace.
    projectName String
    The project name of the vmp workspace.
    prometheusPushIntranetEndpoint String
    The prometheus push intranet endpoint.
    prometheusQueryIntranetEndpoint String
    The prometheus query intranet endpoint.
    prometheusWriteIntranetEndpoint String
    The prometheus write intranet endpoint.
    status String
    The status of workspace.
    tags List<WorkspaceTag>
    Tags.
    username String
    The username of the workspace.
    createTime string
    The create time of workspace.
    deleteProtectionEnabled boolean
    Whether enable delete protection.
    description string
    The description of the workspace.
    instanceTypeId string
    The instance type id of the workspace.
    name string
    The name of the workspace.
    overdueReclaimTime string
    The overdue reclaim time.
    password string
    The password of the workspace.
    projectName string
    The project name of the vmp workspace.
    prometheusPushIntranetEndpoint string
    The prometheus push intranet endpoint.
    prometheusQueryIntranetEndpoint string
    The prometheus query intranet endpoint.
    prometheusWriteIntranetEndpoint string
    The prometheus write intranet endpoint.
    status string
    The status of workspace.
    tags WorkspaceTag[]
    Tags.
    username string
    The username of the workspace.
    create_time str
    The create time of workspace.
    delete_protection_enabled bool
    Whether enable delete protection.
    description str
    The description of the workspace.
    instance_type_id str
    The instance type id of the workspace.
    name str
    The name of the workspace.
    overdue_reclaim_time str
    The overdue reclaim time.
    password str
    The password of the workspace.
    project_name str
    The project name of the vmp workspace.
    prometheus_push_intranet_endpoint str
    The prometheus push intranet endpoint.
    prometheus_query_intranet_endpoint str
    The prometheus query intranet endpoint.
    prometheus_write_intranet_endpoint str
    The prometheus write intranet endpoint.
    status str
    The status of workspace.
    tags Sequence[WorkspaceTagArgs]
    Tags.
    username str
    The username of the workspace.
    createTime String
    The create time of workspace.
    deleteProtectionEnabled Boolean
    Whether enable delete protection.
    description String
    The description of the workspace.
    instanceTypeId String
    The instance type id of the workspace.
    name String
    The name of the workspace.
    overdueReclaimTime String
    The overdue reclaim time.
    password String
    The password of the workspace.
    projectName String
    The project name of the vmp workspace.
    prometheusPushIntranetEndpoint String
    The prometheus push intranet endpoint.
    prometheusQueryIntranetEndpoint String
    The prometheus query intranet endpoint.
    prometheusWriteIntranetEndpoint String
    The prometheus write intranet endpoint.
    status String
    The status of workspace.
    tags List<Property Map>
    Tags.
    username String
    The username of the workspace.

    Supporting Types

    WorkspaceTag, WorkspaceTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Import

    Workspace can be imported using the id, e.g.

    $ pulumi import volcengine:vmp/workspace:Workspace default 60dde3ca-951c-4c05-8777-e5a7caa07ad6

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
    volcengine/pulumi-volcengine