DeviceGroup
- Implements: IDeviceGroup
This class encapsulates and extends the ROS resource type ALIYUN::IOT::DeviceGroup.
Initializers
import com.aliyun.ros.cdk.iot.DeviceGroup;
DeviceGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.groupName(java.lang.String)
.groupName(IResolvable)
// .groupDesc(java.lang.String)
// .groupDesc(IResolvable)
// .iotInstanceId(java.lang.String)
// .iotInstanceId(IResolvable)
// .superGroupId(java.lang.String)
// .superGroupId(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. |
groupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property groupName: The name of the group. |
groupDesc | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property groupDesc: The description of the group. |
iotInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property iotInstanceId: Public instance does not pass this parameter; |
superGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property superGroupId: The ID of the parent group. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
groupNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property groupName: The name of the group.
The alias must be 4 to 30 characters in length, and can contain letters, digits, and underscores (_).
groupDescOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property groupDesc: The description of the group.
You can enter a description with up to 100 characters.
iotInstanceIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property iotInstanceId: Public instance does not pass this parameter;
instance that you need to buy the incoming instance ID.
superGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property superGroupId: The ID of the parent group.
If you want to create a first-level group, do not enter this parameter.
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.iot.DeviceGroup;
DeviceGroup.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. |
attrGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GroupId: Packet, ID, System for the globally unique identifier generated packet. |
attrIotInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IotInstanceId: IOT instance ID. |
props | DeviceGroupProps | 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
attrGroupIdRequired
public java.lang.Object getAttrGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GroupId: Packet, ID, System for the globally unique identifier generated packet.
attrIotInstanceIdRequired
public java.lang.Object getAttrIotInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IotInstanceId: IOT instance ID.
propsRequired
public DeviceGroupProps getProps();
- Type: DeviceGroupProps