ResourceGroups
- Implements: com.aliyun.ros.cdk.resourcemanager.datasource.IResourceGroups
This class encapsulates and extends the ROS resource type DATASOURCE::ResourceManager::ResourceGroups, which is used to query resource groups.
Initializers
import com.aliyun.ros.cdk.resourcemanager.datasource.ResourceGroups;
ResourceGroups.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
// .displayName(java.lang.String)
// .displayName(IResolvable)
// .includeTags(java.lang.Boolean)
// .includeTags(IResolvable)
// .name(java.lang.String)
// .name(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(IResolvable)
// .resourceGroupIds(IResolvable)
// .resourceGroupIds(java.util.List<java.lang.String)
// .resourceGroupIds(IResolvable>)
.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. |
displayName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property displayName: The display name of the resource group. |
includeTags | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property includeTags: Whether to include the tags of the resource groups in the query results. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: The identifier of the resource group. |
refreshOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
resourceGroupIds | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property resourceGroupIds: The IDs of the resource groups. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
displayNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property displayName: The display name of the resource group.
This parameter specifies a filter condition for the query. Fuzzy match is supported.The display name can be a maximum of 50 characters in length.
includeTagsOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property includeTags: Whether to include the tags of the resource groups in the query results.
nameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The identifier of the resource group.
This parameter specifies a filter condition for the query. Fuzzy match is supported. The identifier can be a maximum of 50 characters in length and can contain letters, digits, and hyphens (-).
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
resourceGroupIdsOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property resourceGroupIds: The IDs of the resource groups.
This parameter specifies a filter condition for the query.You can specify a maximum of 100 resource group IDs.
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.resourcemanager.datasource.ResourceGroups;
ResourceGroups.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. |
attrResourceGroupIds | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupIds: The IDs of the resource groups. |
attrResourceGroups | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroups: The list of the resource groups. |
props | ResourceGroupsProps | 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
attrResourceGroupIdsRequired
public java.lang.Object getAttrResourceGroupIds();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupIds: The IDs of the resource groups.
attrResourceGroupsRequired
public java.lang.Object getAttrResourceGroups();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroups: The list of the resource groups.
propsRequired
public ResourceGroupsProps getProps();
- Type: ResourceGroupsProps