1. Packages
  2. Volcengine
  3. API Docs
  4. bioos
  5. Workspace
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine

volcengine.bioos.Workspace

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine

    Provides a resource to manage bioos workspace

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Bioos.Workspace("foo", new()
        {
            CoverPath = "template-cover/pic5.png",
            Description = "test-description23",
        });
    
        //必填
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/bioos"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := bioos.NewWorkspace(ctx, "foo", &bioos.WorkspaceArgs{
    			CoverPath:   pulumi.String("template-cover/pic5.png"),
    			Description: pulumi.String("test-description23"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.bioos.Workspace;
    import com.pulumi.volcengine.bioos.WorkspaceArgs;
    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()        
                .coverPath("template-cover/pic5.png")
                .description("test-description23")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.bioos.Workspace("foo",
        cover_path="template-cover/pic5.png",
        description="test-description23")
    #必填
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.bioos.Workspace("foo", {
        coverPath: "template-cover/pic5.png",
        description: "test-description23",
    });
    //必填
    
    resources:
      foo:
        type: volcengine:bioos:Workspace
        properties:
          coverPath: template-cover/pic5.png
          # 选填
          description: test-description23
    

    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,
                  description: Optional[str] = None,
                  cover_path: Optional[str] = None,
                  name: 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:bioos: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 workspaceResource = new Volcengine.Bioos.Workspace("workspaceResource", new()
    {
        Description = "string",
        CoverPath = "string",
        Name = "string",
    });
    
    example, err := bioos.NewWorkspace(ctx, "workspaceResource", &bioos.WorkspaceArgs{
    	Description: pulumi.String("string"),
    	CoverPath:   pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var workspaceResource = new Workspace("workspaceResource", WorkspaceArgs.builder()
        .description("string")
        .coverPath("string")
        .name("string")
        .build());
    
    workspace_resource = volcengine.bioos.Workspace("workspaceResource",
        description="string",
        cover_path="string",
        name="string")
    
    const workspaceResource = new volcengine.bioos.Workspace("workspaceResource", {
        description: "string",
        coverPath: "string",
        name: "string",
    });
    
    type: volcengine:bioos:Workspace
    properties:
        coverPath: string
        description: string
        name: 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

    The Workspace resource accepts the following input properties:

    Description string
    The description of the workspace.
    CoverPath string
    Cover path (relative path in tos bucket).
    Name string
    The name of the workspace.
    Description string
    The description of the workspace.
    CoverPath string
    Cover path (relative path in tos bucket).
    Name string
    The name of the workspace.
    description String
    The description of the workspace.
    coverPath String
    Cover path (relative path in tos bucket).
    name String
    The name of the workspace.
    description string
    The description of the workspace.
    coverPath string
    Cover path (relative path in tos bucket).
    name string
    The name of the workspace.
    description str
    The description of the workspace.
    cover_path str
    Cover path (relative path in tos bucket).
    name str
    The name of the workspace.
    description String
    The description of the workspace.
    coverPath String
    Cover path (relative path in tos bucket).
    name String
    The name of the workspace.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Updated bool
    Whether the update complete.
    WorkspaceId string
    The id of the workspace.
    Id string
    The provider-assigned unique ID for this managed resource.
    Updated bool
    Whether the update complete.
    WorkspaceId string
    The id of the workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    updated Boolean
    Whether the update complete.
    workspaceId String
    The id of the workspace.
    id string
    The provider-assigned unique ID for this managed resource.
    updated boolean
    Whether the update complete.
    workspaceId string
    The id of the workspace.
    id str
    The provider-assigned unique ID for this managed resource.
    updated bool
    Whether the update complete.
    workspace_id str
    The id of the workspace.
    id String
    The provider-assigned unique ID for this managed resource.
    updated Boolean
    Whether the update complete.
    workspaceId String
    The id of the 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,
            cover_path: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            updated: Optional[bool] = None,
            workspace_id: 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)
    Resource lookup is not supported in YAML
    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:
    CoverPath string
    Cover path (relative path in tos bucket).
    Description string
    The description of the workspace.
    Name string
    The name of the workspace.
    Updated bool
    Whether the update complete.
    WorkspaceId string
    The id of the workspace.
    CoverPath string
    Cover path (relative path in tos bucket).
    Description string
    The description of the workspace.
    Name string
    The name of the workspace.
    Updated bool
    Whether the update complete.
    WorkspaceId string
    The id of the workspace.
    coverPath String
    Cover path (relative path in tos bucket).
    description String
    The description of the workspace.
    name String
    The name of the workspace.
    updated Boolean
    Whether the update complete.
    workspaceId String
    The id of the workspace.
    coverPath string
    Cover path (relative path in tos bucket).
    description string
    The description of the workspace.
    name string
    The name of the workspace.
    updated boolean
    Whether the update complete.
    workspaceId string
    The id of the workspace.
    cover_path str
    Cover path (relative path in tos bucket).
    description str
    The description of the workspace.
    name str
    The name of the workspace.
    updated bool
    Whether the update complete.
    workspace_id str
    The id of the workspace.
    coverPath String
    Cover path (relative path in tos bucket).
    description String
    The description of the workspace.
    name String
    The name of the workspace.
    updated Boolean
    Whether the update complete.
    workspaceId String
    The id of the workspace.

    Import

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

     $ pulumi import volcengine:bioos/workspace:Workspace default *****
    

    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.24 published on Tuesday, Jun 25, 2024 by Volcengine