ResourceGroup
- Implements: IResourceGroup
This class encapsulates and extends the ROS resource type ALIYUN::ADBLake::ResourceGroup.
Initializers
import com.aliyun.ros.cdk.adblake.ResourceGroup;
ResourceGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.dbClusterId(java.lang.String)
.dbClusterId(IResolvable)
.engine(java.lang.String)
.engine(IResolvable)
.groupName(java.lang.String)
.groupName(IResolvable)
.groupType(java.lang.String)
.groupType(IResolvable)
// .autoStopInterval(java.lang.String)
// .autoStopInterval(IResolvable)
// .clusterMode(java.lang.String)
// .clusterMode(IResolvable)
// .clusterSizeResource(java.lang.String)
// .clusterSizeResource(IResolvable)
// .enableSpot(java.lang.Boolean)
// .enableSpot(IResolvable)
// .engineParams(IResolvable)
// .engineParams(java.util.Map<java.lang.String, java.lang.Object>)
// .maxClusterCount(java.lang.Number)
// .maxClusterCount(IResolvable)
// .maxComputeResource(java.lang.String)
// .maxComputeResource(IResolvable)
// .minClusterCount(java.lang.Number)
// .minClusterCount(IResolvable)
// .minComputeResource(java.lang.String)
// .minComputeResource(IResolvable)
// .rules(IResolvable)
// .rules(java.util.List<IResolvable)
// .rules(RulesProperty>)
.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. |
dbClusterId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dbClusterId: The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. |
engine | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property engine: The database engine. |
groupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property groupName: The name of the resource group. |
groupType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property groupType: The type of the resource group. |
autoStopInterval | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property autoStopInterval: Automatically stop time, the unit is minutes (m). |
clusterMode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clusterMode: This parameter is reserved. |
clusterSizeResource | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property clusterSizeResource: A reserved parameter. |
enableSpot | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enableSpot: Specifies whether to enable the spot instance feature for the resource group. |
engineParams | com.aliyun.ros.cdk.core.IResolvable OR java.util.Map | Property engineParams: Engine configuration. |
maxClusterCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property maxClusterCount: A reserved parameter. |
maxComputeResource | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property maxComputeResource: The maximum reserved computing resources. |
minClusterCount | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property minClusterCount: A reserved parameter. |
minComputeResource | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property minComputeResource: The minimum reserved computing resources. |
rules | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property rules: The job resubmission rules. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
dbClusterIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dbClusterId: The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.
engineRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property engine: The database engine.
Valid values:
- AnalyticDB (default): the AnalyticDB for MySQL engine.
- SparkWarehouse: the SparkWarehouse engine.
groupNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property groupName: The name of the resource group.
The name can be up to 255 characters in length. The name must start with a letter or digit. The name can contain letters, digits, hyphens (-), and underscores (_).
groupTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property groupType: The type of the resource group.
Valid values: Interactive Job Note For more information about resource groups, see Resource group overview.
autoStopIntervalOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property autoStopInterval: Automatically stop time, the unit is minutes (m).
clusterModeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterMode: This parameter is reserved.
clusterSizeResourceOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property clusterSizeResource: A reserved parameter.
enableSpotOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enableSpot: Specifies whether to enable the spot instance feature for the resource group.
After you enable the spot instance feature, you are charged for resources at a lower unit price but the resources are probably released. You can enable the spot instance feature only for job resource groups. Valid values: True False
engineParamsOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property engineParams: Engine configuration.
maxClusterCountOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property maxClusterCount: A reserved parameter.
maxComputeResourceOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property maxComputeResource: The maximum reserved computing resources.
If GroupType is set to Interactive, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 16ACU. If GroupType is set to Job, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 8ACU.
minClusterCountOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property minClusterCount: A reserved parameter.
minComputeResourceOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property minComputeResource: The minimum reserved computing resources.
When GroupType is set to Interactive, set this parameter to 16ACU. When GroupType is set to Job, set this parameter to 0ACU.
rulesOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
RulesProperty>
Property rules: The job resubmission rules.
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.adblake.ResourceGroup;
ResourceGroup.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. |
attrGroupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GroupName: The name of the resource group. |
attrGroupType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GroupType: The type of the resource group. |
attrGroupUsers | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GroupUsers: The list of users in the resource group. |
props | ResourceGroupProps | 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
attrGroupNameRequired
public java.lang.Object getAttrGroupName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GroupName: The name of the resource group.
attrGroupTypeRequired
public java.lang.Object getAttrGroupType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GroupType: The type of the resource group.
attrGroupUsersRequired
public java.lang.Object getAttrGroupUsers();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GroupUsers: The list of users in the resource group.
propsRequired
public ResourceGroupProps getProps();
- Type: ResourceGroupProps