WorkspaceResource
- Implements: IWorkspaceResource
This class encapsulates and extends the ROS resource type ALIYUN::PAI::WorkspaceResource.
Initializers
import com.aliyun.ros.cdk.pai.WorkspaceResource;
WorkspaceResource.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.envType(java.lang.String)
.envType(IResolvable)
.resourceType(java.lang.String)
.resourceType(IResolvable)
.workspaceId(java.lang.String)
.workspaceId(IResolvable)
.workspaceResourceName(java.lang.String)
.workspaceResourceName(IResolvable)
// .groupName(java.lang.String)
// .groupName(IResolvable)
// .isDefault(java.lang.Boolean)
// .isDefault(IResolvable)
// .spec(IResolvable)
// .spec(java.util.Map<java.lang.String, java.lang.Object>)
.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. |
envType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property envType: Environment type, possible values: - dev: Development environment. |
resourceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceType: The resource types. |
workspaceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property workspaceId: The ID of the workspace to which the workspace belongs. |
workspaceResourceName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property workspaceResourceName: The resource name. |
groupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property groupName: Resource group name. |
isDefault | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property isDefault: Whether it is the default resource, each resource type has a default resource. |
spec | com.aliyun.ros.cdk.core.IResolvable OR java.util.Map | Property spec: Resource configuration, required for public resource groups of DLC, enter the content: {"clusterType": "share"}. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
envTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property envType: Environment type, possible values: - dev: Development environment.
- prod: Production environment.
resourceTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceType: The resource types.
Valid values: MaxCompute ECS Lingjun ACS FLINK
workspaceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property workspaceId: The ID of the workspace to which the workspace belongs.
workspaceResourceNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property workspaceResourceName: The resource name.
groupNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property groupName: Resource group name.
If you want to obtain a resource group name, see ListResources.
isDefaultOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property isDefault: Whether it is the default resource, each resource type has a default resource.
Possible values:
- true: is the default resource.
- false: Not the default resource.
specOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property spec: Resource configuration, required for public resource groups of DLC, enter the content: {"clusterType": "share"}.
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.pai.WorkspaceResource;
WorkspaceResource.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: Create UTC time in ISO8601 format. |
attrEnvType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EnvType: Environment type, possible values:. |
attrGroupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GroupName: Resource group name. |
attrIsDefault | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IsDefault: Whether it is the default resource, each resource type has a default resource. |
attrResourceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceId: The resource ID. |
attrResourceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceType: Resource type, possible values:. |
attrSpec | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Spec: Resource configuration, required for public resource groups of DLC, enter the content. |
attrWorkspaceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute WorkspaceId: The ID of the workspace to which the workspace belongs. |
attrWorkspaceResourceName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute WorkspaceResourceName: The resource name. |
props | WorkspaceResourceProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: Create UTC time in ISO8601 format.
attrEnvTypeRequired
public java.lang.Object getAttrEnvType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EnvType: Environment type, possible values:.
attrGroupNameRequired
public java.lang.Object getAttrGroupName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GroupName: Resource group name.
If you want to obtain a resource group name, see ListResources.
attrIsDefaultRequired
public java.lang.Object getAttrIsDefault();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IsDefault: Whether it is the default resource, each resource type has a default resource.
attrResourceIdRequired
public java.lang.Object getAttrResourceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceId: The resource ID.
attrResourceTypeRequired
public java.lang.Object getAttrResourceType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceType: Resource type, possible values:.
attrSpecRequired
public java.lang.Object getAttrSpec();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Spec: Resource configuration, required for public resource groups of DLC, enter the content.
attrWorkspaceIdRequired
public java.lang.Object getAttrWorkspaceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute WorkspaceId: The ID of the workspace to which the workspace belongs.
attrWorkspaceResourceNameRequired
public java.lang.Object getAttrWorkspaceResourceName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute WorkspaceResourceName: The resource name.
propsRequired
public WorkspaceResourceProps getProps();
- Type: WorkspaceResourceProps