ResourceGroup
- Implements: IResourceGroup
This class encapsulates and extends the ROS resource type ALIYUN::DataWorks::ResourceGroup.
Initializers
import com.aliyun.ros.cdk.dataworks.ResourceGroup;
ResourceGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.name(java.lang.String)
.name(IResolvable)
.paymentType(java.lang.String)
.paymentType(IResolvable)
.vpcId(java.lang.String)
.vpcId(IResolvable)
.vSwitchId(java.lang.String)
.vSwitchId(IResolvable)
// .autoRenewEnabled(java.lang.Boolean)
// .autoRenewEnabled(IResolvable)
// .paymentDuration(java.lang.Number)
// .paymentDuration(IResolvable)
// .paymentDurationUnit(java.lang.String)
// .paymentDurationUnit(IResolvable)
// .remark(java.lang.String)
// .remark(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .spec(java.lang.Number)
// .spec(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. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The name of a common resource group that creates a common resource group must start with a letter and can contain letters, numbers, underscores (_), up to 128 characters. |
paymentType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property paymentType: The type of payment for resource groups, PrePaid represents annual and monthly payments, and PostPaid represents payment by volume. |
vpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vpcId: The default bound VPC ID. |
vSwitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vSwitchId: The default bound switch ID. |
autoRenewEnabled | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property autoRenewEnabled: Whether to renew automatically. |
paymentDuration | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property paymentDuration: Paid time. |
paymentDurationUnit | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property paymentDurationUnit: Paid time unit. |
remark | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property remark: Remarks for creating a common resource group can contain letters, Chinese, numbers, underscores (_), up to 128 characters. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: Alibaba Cloud Resource Group ID. |
spec | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property spec: Resource group specifications, unit CU, required when the resource group payment mode is PrePaid. |
tags | java.util.List<TagsProperty> | Property tags: Tags to attach to ResourceGroup. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
nameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of a common resource group that creates a common resource group must start with a letter and can contain letters, numbers, underscores (_), up to 128 characters.
paymentTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property paymentType: The type of payment for resource groups, PrePaid represents annual and monthly payments, and PostPaid represents payment by volume.
vpcIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpcId: The default bound VPC ID.
vSwitchIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vSwitchId: The default bound switch ID.
autoRenewEnabledOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property autoRenewEnabled: Whether to renew automatically.
paymentDurationOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property paymentDuration: Paid time.
Default is 1.
paymentDurationUnitOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property paymentDurationUnit: Paid time unit.
Valid values: Month: represents monthly subscription Year: represents annual subscription. Default is Month.
remarkOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property remark: Remarks for creating a common resource group can contain letters, Chinese, numbers, underscores (_), up to 128 characters.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: Alibaba Cloud Resource Group ID.
specOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property spec: Resource group specifications, unit CU, required when the resource group payment mode is PrePaid.
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags to attach to ResourceGroup.
Max support 20 tags to add during create ResourceGroup. 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. |
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.dataworks.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. |
attrId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Id: Creates a unique identifier for a common 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
attrIdRequired
public java.lang.Object getAttrId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Id: Creates a unique identifier for a common resource group.
propsRequired
public ResourceGroupProps getProps();
- Type: ResourceGroupProps