Skip to content

ResourceGroup

This class encapsulates and extends the ROS resource type ALIYUN::ResourceManager::ResourceGroup.

Initializers

import com.aliyun.ros.cdk.resourcemanager.ResourceGroup;
ResourceGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .displayName(java.lang.String)
    .displayName(IResolvable)
    .name(java.lang.String)
    .name(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.
displayName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property displayName: The display name of the resource group.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the resource group.
tags java.util.List<TagsProperty> Property tags: Tags to attach to resource group.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

displayNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property displayName: The display name of the resource group.


nameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property name: The name of the resource group.


tagsOptional

Property tags: Tags to attach to resource group.

Max support 20 tags to add during create resource group. 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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • 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)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.resourcemanager.ResourceGroup;
ResourceGroup.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • 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.
attrAccountId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AccountId: The ID of the Alibaba Cloud account to which the resource group belongs.
attrDisplayName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DisplayName: The display name of the resource group.
attrId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Id: The ID of the resource group.
attrName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Name: The unique identifier of the resource group.
attrRegionStatuses java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RegionStatuses: The status of the resource group in all regions.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of 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

attrAccountIdRequired

public java.lang.Object getAttrAccountId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AccountId: The ID of the Alibaba Cloud account to which the resource group belongs.


attrDisplayNameRequired

public java.lang.Object getAttrDisplayName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute DisplayName: The display name of the resource group.


attrIdRequired

public java.lang.Object getAttrId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Id: The ID of the resource group.


attrNameRequired

public java.lang.Object getAttrName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Name: The unique identifier of the resource group.


attrRegionStatusesRequired

public java.lang.Object getAttrRegionStatuses();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RegionStatuses: The status of the resource group in all regions.


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


propsRequired

public ResourceGroupProps getProps();