Skip to content

Project

This class encapsulates and extends the ROS resource type ALIYUN::DataWorks::Project.

Initializers 

import ros_cdk_dataworks
ros_cdk_dataworks.Project(
  scope: Construct,
  id: str,
  project_identifier: typing.Union[str, IResolvable],
  disable_development: typing.Union[bool, IResolvable] = None,
  is_allow_download: typing.Union[bool, IResolvable] = None,
  project_description: typing.Union[str, IResolvable] = None,
  project_mode: typing.Union[typing.Union[int, float], IResolvable] = None,
  project_name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
project_identifier typing.Union[str, ros_cdk_core.IResolvable] Property projectIdentifier: The name of the workspace.
disable_development typing.Union[bool, ros_cdk_core.IResolvable] Property disableDevelopment: Specifies whether to disable the Development role.
is_allow_download typing.Union[bool, ros_cdk_core.IResolvable] Property isAllowDownload: Specifies whether query result download from DataStudio is allowed.
project_description typing.Union[str, ros_cdk_core.IResolvable] Property projectDescription: The description of the workspace.
project_mode typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property projectMode: The mode of the workspace.
project_name typing.Union[str, ros_cdk_core.IResolvable] Property projectName: The display name of the workspace.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
tags typing.List[TagsProperty] Property tags: Tags to attach to workspace.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

project_identifierRequired

  • Type: typing.Union[str, 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.

disable_developmentOptional

  • Type: typing.Union[bool, 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.

is_allow_downloadOptional

  • Type: typing.Union[bool, 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.

project_descriptionOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property projectDescription: The description of the workspace.

If not provided, it is the same as ProjectIdentifier.

project_modeOptional

  • Type: typing.Union[typing.Union[int, float], 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.

project_nameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property projectName: The display name of the workspace.

If not provided, it is the same as ProjectIdentifier.

resource_group_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

tagsOptional

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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_dataworks
ros_cdk_dataworks.Project.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_env_types ros_cdk_core.IResolvable Attribute EnvTypes: The environment of the workspace.
attr_is_default ros_cdk_core.IResolvable Attribute IsDefault: Indicates whether the workspace is the default workspace.
attr_project_id ros_cdk_core.IResolvable Attribute ProjectId: The ID of the workspace.
attr_project_identifier ros_cdk_core.IResolvable Attribute ProjectIdentifier: The name of the workspace.
attr_protected_mode ros_cdk_core.IResolvable Attribute ProtectedMode: Indicates whether the workspace protection feature is enabled.
attr_resident_area ros_cdk_core.IResolvable Attribute ResidentArea: The type of the workspace.
attr_scheduler_max_retry_times ros_cdk_core.IResolvable Attribute SchedulerMaxRetryTimes: The default maximum number of automatic reruns that are allowed after an error occurs.
attr_scheduler_retry_interval ros_cdk_core.IResolvable Attribute SchedulerRetryInterval: The interval between automatic reruns after an error occurs.
attr_table_privacy_mode ros_cdk_core.IResolvable Attribute TablePrivacyMode: Indicates whether the MaxCompute tables in the workspace are visible to the users within the tenant.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_env_typesRequired 

attr_env_types: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EnvTypes: The environment of the workspace.

Valid values: PROD and DEV. The value PROD indicates the production environment. Workspaces in basic mode provide only the production environment. The value DEV indicates the development environment. Workspaces in standard mode provide both the development environment and the production environment.

attr_is_defaultRequired 

attr_is_default: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IsDefault: Indicates whether the workspace is the default workspace.

Valid values: 1: The workspace is the default workspace. 0: The workspace is not the default workspace.

attr_project_idRequired 

attr_project_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ProjectId: The ID of the workspace.

attr_project_identifierRequired 

attr_project_identifier: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ProjectIdentifier: The name of the workspace.

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

attr_protected_modeRequired 

attr_protected_mode: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ProtectedMode: Indicates whether the workspace protection feature is enabled.

Valid values: 1: The workspace protection feature is enabled. 0: The workspace protection feature is disabled.

attr_resident_areaRequired 

attr_resident_area: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResidentArea: The type of the workspace.

Valid values: private and swap.

attr_scheduler_max_retry_timesRequired 

attr_scheduler_max_retry_times: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SchedulerMaxRetryTimes: The default maximum number of automatic reruns that are allowed after an error occurs.

attr_scheduler_retry_intervalRequired 

attr_scheduler_retry_interval: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SchedulerRetryInterval: The interval between automatic reruns after an error occurs.

Unit: milliseconds. The maximum interval is 30 minutes. You must pay attention to the conversion between units.

attr_table_privacy_modeRequired 

attr_table_privacy_mode: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TablePrivacyMode: Indicates whether the MaxCompute tables in the workspace are visible to the users within the tenant.

Valid values: 0: The MaxCompute tables are invisible to the users within a tenant. 1: The MaxCompute tables are visible to the users within a tenant.