Project
This class encapsulates and extends the ROS resource type ALIYUN::DataWorks::Project, which is used to create a DataWorks workspace.
Initializers
import { Project } from '@alicloud/ros-cdk-dataworks'
new Project(scope: Construct, id: string, props: ProjectProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope |
@alicloud/ros-cdk-core.Construct |
No description. |
id |
string |
No description. |
props |
ProjectProps |
No description. |
enableResourcePropertyConstraint |
boolean |
No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: ProjectProps
enableResourcePropertyConstraintOptional
- Type: boolean
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 toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct |
Return whether the given object is a Construct. |
isConstruct
import { Project } from '@alicloud/ros-cdk-dataworks'
Project.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node |
@alicloud/ros-cdk-core.ConstructNode |
The construct tree node associated with this construct. |
ref |
string |
No description. |
stack |
@alicloud/ros-cdk-core.Stack |
The stack in which this resource is defined. |
resource |
@alicloud/ros-cdk-core.RosResource |
No description. |
attrEnvTypes |
@alicloud/ros-cdk-core.IResolvable |
Attribute EnvTypes: The environment of the workspace. |
attrIsDefault |
@alicloud/ros-cdk-core.IResolvable |
Attribute IsDefault: Indicates whether the workspace is the default workspace. |
attrProjectId |
@alicloud/ros-cdk-core.IResolvable |
Attribute ProjectId: The ID of the workspace. |
attrProjectIdentifier |
@alicloud/ros-cdk-core.IResolvable |
Attribute ProjectIdentifier: The name of the workspace. |
attrProtectedMode |
@alicloud/ros-cdk-core.IResolvable |
Attribute ProtectedMode: Indicates whether the workspace protection feature is enabled. |
attrResidentArea |
@alicloud/ros-cdk-core.IResolvable |
Attribute ResidentArea: The type of the workspace. |
attrSchedulerMaxRetryTimes |
@alicloud/ros-cdk-core.IResolvable |
Attribute SchedulerMaxRetryTimes: The default maximum number of automatic reruns that are allowed after an error occurs. |
attrSchedulerRetryInterval |
@alicloud/ros-cdk-core.IResolvable |
Attribute SchedulerRetryInterval: The interval between automatic reruns after an error occurs. |
attrTablePrivacyMode |
@alicloud/ros-cdk-core.IResolvable |
Attribute TablePrivacyMode: Indicates whether the MaxCompute tables in the workspace are visible to the users within the tenant. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
refRequired
public readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrEnvTypesRequired
public readonly attrEnvTypes: IResolvable;
- Type: @alicloud/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 readonly attrIsDefault: IResolvable;
- Type: @alicloud/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 readonly attrProjectId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
Attribute ProjectId: The ID of the workspace.
attrProjectIdentifierRequired
public readonly attrProjectIdentifier: IResolvable;
- Type: @alicloud/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 readonly attrProtectedMode: IResolvable;
- Type: @alicloud/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 readonly attrResidentArea: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
Attribute ResidentArea: The type of the workspace.
Valid values: private and swap.
attrSchedulerMaxRetryTimesRequired
public readonly attrSchedulerMaxRetryTimes: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
Attribute SchedulerMaxRetryTimes: The default maximum number of automatic reruns that are allowed after an error occurs.
attrSchedulerRetryIntervalRequired
public readonly attrSchedulerRetryInterval: IResolvable;
- Type: @alicloud/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 readonly attrTablePrivacyMode: IResolvable;
- Type: @alicloud/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.