Project

• Implements: IProject

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

Initializers

import com.aliyun.ros.cdk.dataworks.Project;
Project.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .projectIdentifier(java.lang.String)
    .projectIdentifier(IResolvable)
//  .disableDevelopment(java.lang.Boolean)
//  .disableDevelopment(IResolvable)
//  .isAllowDownload(java.lang.Boolean)
//  .isAllowDownload(IResolvable)
//  .projectDescription(java.lang.String)
//  .projectDescription(IResolvable)
//  .projectMode(java.lang.Number)
//  .projectMode(IResolvable)
//  .projectName(java.lang.String)
//  .projectName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

projectIdentifier^Required

• Type: java.lang.String OR com.aliyun.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.

disableDevelopment^Optional

• Type: java.lang.Boolean OR com.aliyun.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.

isAllowDownload^Optional

• Type: java.lang.Boolean OR com.aliyun.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.

projectDescription^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property projectDescription: The description of the workspace.

If not provided, it is the same as ProjectIdentifier.

projectMode^Optional

• Type: java.lang.Number OR com.aliyun.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.

projectName^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property projectName: The display name of the workspace.

If not provided, it is the same as ProjectIdentifier.The value contains 3 to 28 characters.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

tags^Optional

• Type: java.util.List<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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.dataworks.Project;
Project.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrEnvTypes^Required

public java.lang.Object getAttrEnvTypes();

• Type: java.lang.String OR com.aliyun.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.

attrId^Required

public java.lang.Object getAttrId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Id: The ID number of the workspace.

attrIsDefault^Required

public java.lang.Object getAttrIsDefault();

• Type: java.lang.String OR com.aliyun.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.

attrProjectIdentifier^Required

public java.lang.Object getAttrProjectIdentifier();

• Type: java.lang.String OR com.aliyun.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.

attrProtectedMode^Required

public java.lang.Object getAttrProtectedMode();

• Type: java.lang.String OR com.aliyun.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.

attrResidentArea^Required

public java.lang.Object getAttrResidentArea();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResidentArea: The type of the workspace.

Valid values: private and swap.

attrSchedulerMaxRetryTimes^Required

public java.lang.Object getAttrSchedulerMaxRetryTimes();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrSchedulerRetryInterval^Required

public java.lang.Object getAttrSchedulerRetryInterval();

• Type: java.lang.String OR com.aliyun.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.

attrTablePrivacyMode^Required

public java.lang.Object getAttrTablePrivacyMode();

• Type: java.lang.String OR com.aliyun.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.

props^Required

public ProjectProps getProps();

• Type: ProjectProps