Alibaba Cloud v3.76.0, Apr 8 25

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.pai.WorkspaceDataset

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

Basic Usage

TypeScript
Python
Go
C#
Java
YAML

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform_example";
const defaultWorkspace = new alicloud.pai.WorkspaceWorkspace("defaultWorkspace", {
    description: name,
    displayName: name,
    workspaceName: name,
    envTypes: ["prod"],
});
const _default = new alicloud.pai.WorkspaceDataset("default", {
    options: JSON.stringify({
        mountPath: "/mnt/data/",
    }),
    description: name,
    accessibility: "PRIVATE",
    datasetName: name,
    dataSourceType: "NAS",
    sourceType: "ITAG",
    workspaceId: defaultWorkspace.id,
    dataType: "PIC",
    property: "DIRECTORY",
    uri: "nas://086b649545.cn-hangzhou/",
    sourceId: "d-xxxxx_v1",
    userId: "1511928242963727",
});

import pulumi
import json
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform_example"
default_workspace = alicloud.pai.WorkspaceWorkspace("defaultWorkspace",
    description=name,
    display_name=name,
    workspace_name=name,
    env_types=["prod"])
default = alicloud.pai.WorkspaceDataset("default",
    options=json.dumps({
        "mountPath": "/mnt/data/",
    }),
    description=name,
    accessibility="PRIVATE",
    dataset_name=name,
    data_source_type="NAS",
    source_type="ITAG",
    workspace_id=default_workspace.id,
    data_type="PIC",
    property="DIRECTORY",
    uri="nas://086b649545.cn-hangzhou/",
    source_id="d-xxxxx_v1",
    user_id="1511928242963727")

package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/pai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform_example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		defaultWorkspace, err := pai.NewWorkspaceWorkspace(ctx, "defaultWorkspace", &pai.WorkspaceWorkspaceArgs{
			Description:   pulumi.String(name),
			DisplayName:   pulumi.String(name),
			WorkspaceName: pulumi.String(name),
			EnvTypes: pulumi.StringArray{
				pulumi.String("prod"),
			},
		})
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"mountPath": "/mnt/data/",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = pai.NewWorkspaceDataset(ctx, "default", &pai.WorkspaceDatasetArgs{
			Options:        pulumi.String(json0),
			Description:    pulumi.String(name),
			Accessibility:  pulumi.String("PRIVATE"),
			DatasetName:    pulumi.String(name),
			DataSourceType: pulumi.String("NAS"),
			SourceType:     pulumi.String("ITAG"),
			WorkspaceId:    defaultWorkspace.ID(),
			DataType:       pulumi.String("PIC"),
			Property:       pulumi.String("DIRECTORY"),
			Uri:            pulumi.String("nas://086b649545.cn-hangzhou/"),
			SourceId:       pulumi.String("d-xxxxx_v1"),
			UserId:         pulumi.String("1511928242963727"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform_example";
    var defaultWorkspace = new AliCloud.Pai.WorkspaceWorkspace("defaultWorkspace", new()
    {
        Description = name,
        DisplayName = name,
        WorkspaceName = name,
        EnvTypes = new[]
        {
            "prod",
        },
    });

    var @default = new AliCloud.Pai.WorkspaceDataset("default", new()
    {
        Options = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["mountPath"] = "/mnt/data/",
        }),
        Description = name,
        Accessibility = "PRIVATE",
        DatasetName = name,
        DataSourceType = "NAS",
        SourceType = "ITAG",
        WorkspaceId = defaultWorkspace.Id,
        DataType = "PIC",
        Property = "DIRECTORY",
        Uri = "nas://086b649545.cn-hangzhou/",
        SourceId = "d-xxxxx_v1",
        UserId = "1511928242963727",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.pai.WorkspaceWorkspace;
import com.pulumi.alicloud.pai.WorkspaceWorkspaceArgs;
import com.pulumi.alicloud.pai.WorkspaceDataset;
import com.pulumi.alicloud.pai.WorkspaceDatasetArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("terraform_example");
        var defaultWorkspace = new WorkspaceWorkspace("defaultWorkspace", WorkspaceWorkspaceArgs.builder()
            .description(name)
            .displayName(name)
            .workspaceName(name)
            .envTypes("prod")
            .build());

        var default_ = new WorkspaceDataset("default", WorkspaceDatasetArgs.builder()
            .options(serializeJson(
                jsonObject(
                    jsonProperty("mountPath", "/mnt/data/")
                )))
            .description(name)
            .accessibility("PRIVATE")
            .datasetName(name)
            .dataSourceType("NAS")
            .sourceType("ITAG")
            .workspaceId(defaultWorkspace.id())
            .dataType("PIC")
            .property("DIRECTORY")
            .uri("nas://086b649545.cn-hangzhou/")
            .sourceId("d-xxxxx_v1")
            .userId("1511928242963727")
            .build());

    }
}

configuration:
  name:
    type: string
    default: terraform_example
resources:
  defaultWorkspace:
    type: alicloud:pai:WorkspaceWorkspace
    properties:
      description: ${name}
      displayName: ${name}
      workspaceName: ${name}
      envTypes:
        - prod
  default:
    type: alicloud:pai:WorkspaceDataset
    properties:
      options:
        fn::toJSON:
          mountPath: /mnt/data/
      description: ${name}
      accessibility: PRIVATE
      datasetName: ${name}
      dataSourceType: NAS
      sourceType: ITAG
      workspaceId: ${defaultWorkspace.id}
      dataType: PIC
      property: DIRECTORY
      uri: nas://086b649545.cn-hangzhou/
      sourceId: d-xxxxx_v1
      userId: '1511928242963727'

Create WorkspaceDataset Resource

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

new WorkspaceDataset(name: string, args: WorkspaceDatasetArgs, opts?: CustomResourceOptions);

@overload
def WorkspaceDataset(resource_name: str,
                     args: WorkspaceDatasetArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def WorkspaceDataset(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     property: Optional[str] = None,
                     data_source_type: Optional[str] = None,
                     workspace_id: Optional[str] = None,
                     dataset_name: Optional[str] = None,
                     uri: Optional[str] = None,
                     options: Optional[str] = None,
                     accessibility: Optional[str] = None,
                     labels: Optional[Sequence[WorkspaceDatasetLabelArgs]] = None,
                     source_id: Optional[str] = None,
                     source_type: Optional[str] = None,
                     description: Optional[str] = None,
                     user_id: Optional[str] = None,
                     data_type: Optional[str] = None)

func NewWorkspaceDataset(ctx *Context, name string, args WorkspaceDatasetArgs, opts ...ResourceOption) (*WorkspaceDataset, error)

public WorkspaceDataset(string name, WorkspaceDatasetArgs args, CustomResourceOptions? opts = null)

public WorkspaceDataset(String name, WorkspaceDatasetArgs args)
public WorkspaceDataset(String name, WorkspaceDatasetArgs args, CustomResourceOptions options)

type: alicloud:pai:WorkspaceDataset
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 WorkspaceDatasetArgs: 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 WorkspaceDatasetArgs: 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 WorkspaceDatasetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args WorkspaceDatasetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args WorkspaceDatasetArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var workspaceDatasetResource = new AliCloud.Pai.WorkspaceDataset("workspaceDatasetResource", new()
{
    Property = "string",
    DataSourceType = "string",
    WorkspaceId = "string",
    DatasetName = "string",
    Uri = "string",
    Options = "string",
    Accessibility = "string",
    Labels = new[]
    {
        new AliCloud.Pai.Inputs.WorkspaceDatasetLabelArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    SourceId = "string",
    SourceType = "string",
    Description = "string",
    UserId = "string",
    DataType = "string",
});

example, err := pai.NewWorkspaceDataset(ctx, "workspaceDatasetResource", &pai.WorkspaceDatasetArgs{
	Property:       pulumi.String("string"),
	DataSourceType: pulumi.String("string"),
	WorkspaceId:    pulumi.String("string"),
	DatasetName:    pulumi.String("string"),
	Uri:            pulumi.String("string"),
	Options:        pulumi.String("string"),
	Accessibility:  pulumi.String("string"),
	Labels: pai.WorkspaceDatasetLabelArray{
		&pai.WorkspaceDatasetLabelArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	SourceId:    pulumi.String("string"),
	SourceType:  pulumi.String("string"),
	Description: pulumi.String("string"),
	UserId:      pulumi.String("string"),
	DataType:    pulumi.String("string"),
})

var workspaceDatasetResource = new WorkspaceDataset("workspaceDatasetResource", WorkspaceDatasetArgs.builder()
    .property("string")
    .dataSourceType("string")
    .workspaceId("string")
    .datasetName("string")
    .uri("string")
    .options("string")
    .accessibility("string")
    .labels(WorkspaceDatasetLabelArgs.builder()
        .key("string")
        .value("string")
        .build())
    .sourceId("string")
    .sourceType("string")
    .description("string")
    .userId("string")
    .dataType("string")
    .build());

workspace_dataset_resource = alicloud.pai.WorkspaceDataset("workspaceDatasetResource",
    property="string",
    data_source_type="string",
    workspace_id="string",
    dataset_name="string",
    uri="string",
    options="string",
    accessibility="string",
    labels=[{
        "key": "string",
        "value": "string",
    }],
    source_id="string",
    source_type="string",
    description="string",
    user_id="string",
    data_type="string")

const workspaceDatasetResource = new alicloud.pai.WorkspaceDataset("workspaceDatasetResource", {
    property: "string",
    dataSourceType: "string",
    workspaceId: "string",
    datasetName: "string",
    uri: "string",
    options: "string",
    accessibility: "string",
    labels: [{
        key: "string",
        value: "string",
    }],
    sourceId: "string",
    sourceType: "string",
    description: "string",
    userId: "string",
    dataType: "string",
});

type: alicloud:pai:WorkspaceDataset
properties:
    accessibility: string
    dataSourceType: string
    dataType: string
    datasetName: string
    description: string
    labels:
        - key: string
          value: string
    options: string
    property: string
    sourceId: string
    sourceType: string
    uri: string
    userId: string
    workspaceId: string

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

DataSourceType string

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

DatasetName string

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

Property string

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

Uri string

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

WorkspaceId string

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

Accessibility string

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

DataType string

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

Description string

Custom descriptions of datasets to distinguish between different datasets.

Labels List<Pulumi.AliCloud.Pai.Inputs.WorkspaceDatasetLabel>

Labels added to the dataset See labels below.

Options string

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

SourceId string

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

SourceType string

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

UserId string

The ID of the dataset owner.

DataSourceType string

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

DatasetName string

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

Property string

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

Uri string

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

WorkspaceId string

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

Accessibility string

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

DataType string

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

Description string

Custom descriptions of datasets to distinguish between different datasets.

Labels []WorkspaceDatasetLabelArgs

Labels added to the dataset See labels below.

Options string

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

SourceId string

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

SourceType string

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

UserId string

The ID of the dataset owner.

dataSourceType String

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

datasetName String

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

property String

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

uri String

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

workspaceId String

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

accessibility String

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

dataType String

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

description String

Custom descriptions of datasets to distinguish between different datasets.

labels List<WorkspaceDatasetLabel>

Labels added to the dataset See labels below.

options String

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

sourceId String

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

sourceType String

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

userId String

The ID of the dataset owner.

dataSourceType string

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

datasetName string

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

property string

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

uri string

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

workspaceId string

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

accessibility string

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

dataType string

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

description string

Custom descriptions of datasets to distinguish between different datasets.

labels WorkspaceDatasetLabel[]

Labels added to the dataset See labels below.

options string

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

sourceId string

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

sourceType string

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

userId string

The ID of the dataset owner.

data_source_type str

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

dataset_name str

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

property str

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

uri str

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

workspace_id str

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

accessibility str

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

data_type str

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

description str

Custom descriptions of datasets to distinguish between different datasets.

labels Sequence[WorkspaceDatasetLabelArgs]

Labels added to the dataset See labels below.

options str

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

source_id str

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

source_type str

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

user_id str

The ID of the dataset owner.

dataSourceType String

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

datasetName String

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

property String

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

uri String

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

workspaceId String

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

accessibility String

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

dataType String

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

description String

Custom descriptions of datasets to distinguish between different datasets.

labels List<Property Map>

Labels added to the dataset See labels below.

options String

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

sourceId String

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

sourceType String

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

userId String

The ID of the dataset owner.

Outputs

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

CreateTime string: The creation time of the resource
Id string: The provider-assigned unique ID for this managed resource.

CreateTime string: The creation time of the resource
Id string: The provider-assigned unique ID for this managed resource.

createTime String: The creation time of the resource
id String: The provider-assigned unique ID for this managed resource.

createTime string: The creation time of the resource
id string: The provider-assigned unique ID for this managed resource.

create_time str: The creation time of the resource
id str: The provider-assigned unique ID for this managed resource.

createTime String: The creation time of the resource
id String: The provider-assigned unique ID for this managed resource.

Look up Existing WorkspaceDataset Resource

Get an existing WorkspaceDataset resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: WorkspaceDatasetState, opts?: CustomResourceOptions): WorkspaceDataset

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accessibility: Optional[str] = None,
        create_time: Optional[str] = None,
        data_source_type: Optional[str] = None,
        data_type: Optional[str] = None,
        dataset_name: Optional[str] = None,
        description: Optional[str] = None,
        labels: Optional[Sequence[WorkspaceDatasetLabelArgs]] = None,
        options: Optional[str] = None,
        property: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        uri: Optional[str] = None,
        user_id: Optional[str] = None,
        workspace_id: Optional[str] = None) -> WorkspaceDataset

func GetWorkspaceDataset(ctx *Context, name string, id IDInput, state *WorkspaceDatasetState, opts ...ResourceOption) (*WorkspaceDataset, error)

public static WorkspaceDataset Get(string name, Input<string> id, WorkspaceDatasetState? state, CustomResourceOptions? opts = null)

public static WorkspaceDataset get(String name, Output<String> id, WorkspaceDatasetState state, CustomResourceOptions options)

resources:  _:    type: alicloud:pai:WorkspaceDataset    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:

Accessibility string

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

CreateTime string

The creation time of the resource

DataSourceType string

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

DataType string

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

DatasetName string

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

Description string

Custom descriptions of datasets to distinguish between different datasets.

Labels List<Pulumi.AliCloud.Pai.Inputs.WorkspaceDatasetLabel>

Labels added to the dataset See labels below.

Options string

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

Property string

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

SourceId string

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

SourceType string

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

Uri string

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

UserId string

The ID of the dataset owner.

WorkspaceId string

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

Accessibility string

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

CreateTime string

The creation time of the resource

DataSourceType string

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

DataType string

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

DatasetName string

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

Description string

Custom descriptions of datasets to distinguish between different datasets.

Labels []WorkspaceDatasetLabelArgs

Labels added to the dataset See labels below.

Options string

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

Property string

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

SourceId string

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

SourceType string

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

Uri string

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

UserId string

The ID of the dataset owner.

WorkspaceId string

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

accessibility String

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

createTime String

The creation time of the resource

dataSourceType String

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

dataType String

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

datasetName String

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

description String

Custom descriptions of datasets to distinguish between different datasets.

labels List<WorkspaceDatasetLabel>

Labels added to the dataset See labels below.

options String

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

property String

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

sourceId String

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

sourceType String

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

uri String

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

userId String

The ID of the dataset owner.

workspaceId String

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

accessibility string

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

createTime string

The creation time of the resource

dataSourceType string

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

dataType string

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

datasetName string

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

description string

Custom descriptions of datasets to distinguish between different datasets.

labels WorkspaceDatasetLabel[]

Labels added to the dataset See labels below.

options string

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

property string

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

sourceId string

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

sourceType string

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

uri string

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

userId string

The ID of the dataset owner.

workspaceId string

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

accessibility str

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

create_time str

The creation time of the resource

data_source_type str

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

data_type str

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

dataset_name str

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

description str

Custom descriptions of datasets to distinguish between different datasets.

labels Sequence[WorkspaceDatasetLabelArgs]

Labels added to the dataset See labels below.

options str

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

property str

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

source_id str

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

source_type str

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

uri str

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

user_id str

The ID of the dataset owner.

workspace_id str

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

accessibility String

Workspace visibility. The following values are supported:

PRIVATE (default): indicates that the workspace is visible to itself and the administrator.
PUBLIC: The workspace is visible to all users.

createTime String

The creation time of the resource

dataSourceType String

The data source type. The following values are supported:

OSS: Alibaba Cloud Object Storage (OSS).
NAS: Alibaba cloud file storage (NAS).

dataType String

The dataset type. The default value is COMMON. The following values are supported:

COMMON: COMMON.
PIC: picture.
TEXT: TEXT.
VIDEO: VIDEO.
AUDIO: AUDIO.

datasetName String

The name of the dataset. The naming rules are as follows:

Start with a lowercase letter, uppercase letter, number, or Chinese.
Can contain an underscore (_) or a dash (-).
1~127 characters in length.

description String

Custom descriptions of datasets to distinguish between different datasets.

labels List<Property Map>

Labels added to the dataset See labels below.

options String

The extended field, which is of the JsonString type.

When DLC uses a dataset, you can specify the default Mount path for the dataset by configuring the mountPath field.

property String

The properties of the dataset. The following values are supported:

FILE: FILE.
DIRECTORY: folder.

sourceId String

The data source ID.

When the SourceType is USER, SourceId can be customized.
When SourceType is ITAG, that is, when the iTAG module labels the data set generated by the result, SourceId is the task ID of ITAG.
When SourceType is PAI_PUBLIC_DATASET, that is, a dataset created using PAI public datasets, SourceId is empty by default.

sourceType String

The data source type. The default value is USER. The following values are supported:

PAI-PUBLIC-DATASET:PAI public dataset.
ITAG: The dataset generated by the iTAG module annotation result.
USER: The data set registered by the USER.

uri String

The Uri configuration sample is as follows:

The data source type is OSS:'oss:// bucket.endpoint/object'
The data source type is NAS:

The general NAS format is: 'nas://.region/subpath/to/dir/';

CPFS1.0:'nas://.region/subpath/to/dir /';

CPFS2.0:'nas://.region//'.

CPFS1.0 and CPFS2.0 are distinguished by the format of fsid: CPFS1.0 is cpfs-;CPFS2.0 is cpfs-.

userId String

The ID of the dataset owner.

workspaceId String

The ID of the workspace where the dataset is located. For details about how to obtain the workspace ID, see ListWorkspaces.

If this parameter is not configured, the default workspace is used. If the default workspace does not exist, an error is reported.

Supporting Types

WorkspaceDatasetLabel
, WorkspaceDatasetLabelArgs

Key string: The key of the tag. The length is limited to 128 bytes. "=" and "," are not supported.
Value string: The value of the tag. The length is limited to 128 bytes. "=" and "," are not supported.

Key string: The key of the tag. The length is limited to 128 bytes. "=" and "," are not supported.
Value string: The value of the tag. The length is limited to 128 bytes. "=" and "," are not supported.

key String: The key of the tag. The length is limited to 128 bytes. "=" and "," are not supported.
value String: The value of the tag. The length is limited to 128 bytes. "=" and "," are not supported.

key string: The key of the tag. The length is limited to 128 bytes. "=" and "," are not supported.
value string: The value of the tag. The length is limited to 128 bytes. "=" and "," are not supported.

key str: The key of the tag. The length is limited to 128 bytes. "=" and "," are not supported.
value str: The value of the tag. The length is limited to 128 bytes. "=" and "," are not supported.

key String: The key of the tag. The length is limited to 128 bytes. "=" and "," are not supported.
value String: The value of the tag. The length is limited to 128 bytes. "=" and "," are not supported.

Import

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

$ pulumi import alicloud:pai/workspaceDataset:WorkspaceDataset example <id>

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

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.pai.WorkspaceDataset

On this page

On this page

Example Usage

Create WorkspaceDataset Resource

Constructor syntax

Parameters

Constructor example

WorkspaceDataset Resource Properties

Inputs

Outputs

Look up Existing WorkspaceDataset Resource

Supporting Types

WorkspaceDatasetLabel
, WorkspaceDatasetLabelArgs

Import

Package Details

On this page

On this page

alicloud.pai.WorkspaceDataset

On this page

On this page

Example Usage

Create WorkspaceDataset Resource

Constructor syntax

Parameters

Constructor example

WorkspaceDataset Resource Properties

Inputs

Outputs

Look up Existing WorkspaceDataset Resource

Supporting Types

WorkspaceDatasetLabel, WorkspaceDatasetLabelArgs

Import

Package Details

On this page

On this page

WorkspaceDatasetLabel
, WorkspaceDatasetLabelArgs