Skip to content

Project

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
projectIdentifier java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property projectIdentifier: The name of the workspace.
disableDevelopment java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property disableDevelopment: Specifies whether to disable the Development role.
isAllowDownload java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isAllowDownload: Specifies whether query result download from DataStudio is allowed.
projectDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property projectDescription: The description of the workspace.
projectMode java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property projectMode: The mode of the workspace.
projectName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property projectName: The display name of the workspace.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The ID of the resource group.
tags java.util.List<TagsProperty> Property tags: Tags to attach to workspace.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

projectIdentifierRequired

  • 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.

disableDevelopmentOptional

  • 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.

isAllowDownloadOptional

  • 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.

projectDescriptionOptional

  • 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.

projectModeOptional

  • 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.

projectNameOptional

  • 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.

resourceGroupIdOptional

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

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrEnvTypes com.aliyun.ros.cdk.core.IResolvable Attribute EnvTypes: The environment of the workspace.
attrIsDefault com.aliyun.ros.cdk.core.IResolvable Attribute IsDefault: Indicates whether the workspace is the default workspace.
attrProjectId com.aliyun.ros.cdk.core.IResolvable Attribute ProjectId: The ID of the workspace.
attrProjectIdentifier com.aliyun.ros.cdk.core.IResolvable Attribute ProjectIdentifier: The name of the workspace.
attrProtectedMode com.aliyun.ros.cdk.core.IResolvable Attribute ProtectedMode: Indicates whether the workspace protection feature is enabled.
attrResidentArea com.aliyun.ros.cdk.core.IResolvable Attribute ResidentArea: The type of the workspace.
attrSchedulerMaxRetryTimes com.aliyun.ros.cdk.core.IResolvable Attribute SchedulerMaxRetryTimes: The default maximum number of automatic reruns that are allowed after an error occurs.
attrSchedulerRetryInterval com.aliyun.ros.cdk.core.IResolvable Attribute SchedulerRetryInterval: The interval between automatic reruns after an error occurs.
attrTablePrivacyMode com.aliyun.ros.cdk.core.IResolvable Attribute TablePrivacyMode: Indicates whether the MaxCompute tables in the workspace are visible to the users within the tenant.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrEnvTypesRequired 

public IResolvable getAttrEnvTypes();
  • Type: 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.

attrIsDefaultRequired 

public IResolvable getAttrIsDefault();
  • Type: 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.

attrProjectIdRequired 

public IResolvable getAttrProjectId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ProjectId: The ID of the workspace.

attrProjectIdentifierRequired 

public IResolvable getAttrProjectIdentifier();
  • Type: 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.

attrProtectedModeRequired 

public IResolvable getAttrProtectedMode();
  • Type: 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.

attrResidentAreaRequired 

public IResolvable getAttrResidentArea();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResidentArea: The type of the workspace.

Valid values: private and swap.

attrSchedulerMaxRetryTimesRequired 

public IResolvable getAttrSchedulerMaxRetryTimes();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrSchedulerRetryIntervalRequired 

public IResolvable getAttrSchedulerRetryInterval();
  • Type: 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.

attrTablePrivacyModeRequired 

public IResolvable getAttrTablePrivacyMode();
  • Type: 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.