Skip to content

ProjectProps

Properties for defining a Project.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dataworks-project

Initializer 

import { ProjectProps } from '@alicloud/ros-cdk-dataworks'
const projectProps: ProjectProps = { ... }

Properties

Name Type Description
projectIdentifier string | @alicloud/ros-cdk-core.IResolvable Property projectIdentifier: The name of the workspace.
disableDevelopment boolean | @alicloud/ros-cdk-core.IResolvable Property disableDevelopment: Specifies whether to disable the Development role.
isAllowDownload boolean | @alicloud/ros-cdk-core.IResolvable Property isAllowDownload: Specifies whether query result download from DataStudio is allowed.
projectDescription string | @alicloud/ros-cdk-core.IResolvable Property projectDescription: The description of the workspace.
projectMode number | @alicloud/ros-cdk-core.IResolvable Property projectMode: The mode of the workspace.
projectName string | @alicloud/ros-cdk-core.IResolvable Property projectName: The display name of the workspace.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
tags TagsProperty[] Property tags: Tags to attach to workspace.

projectIdentifierRequired 

public readonly projectIdentifier: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property projectIdentifier: The name of the workspace.

The name can contain letters, digits, and underscores (_) and must start with a letter or digit.

disableDevelopmentOptional 

public readonly disableDevelopment: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property disableDevelopment: Specifies whether to disable the Development role.

Valid values: false: enables the Development role. true: disables the Development role. Default value: false.

isAllowDownloadOptional 

public readonly isAllowDownload: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property isAllowDownload: Specifies whether query result download from DataStudio is allowed.

Valid values: true: allowed false: not allowed Default value: true.

projectDescriptionOptional 

public readonly projectDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property projectDescription: The description of the workspace.

If not provided, it is the same as ProjectIdentifier.

projectModeOptional 

public readonly projectMode: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property projectMode: The mode of the workspace.

For more information about the differences between the modes of workspaces, see Differences between workspaces in basic mode and workspaces in standard mode. Valid values: 2: basic mode 3: standard mode Default value: 2.

projectNameOptional 

public readonly projectName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property projectName: The display name of the workspace.

If not provided, it is the same as ProjectIdentifier.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public readonly tags: TagsProperty[];

Property tags: Tags to attach to workspace.

Max support 20 tags to add during create workspace. Each tag with two properties Key and Value, and Key is required.