Device

• Implements: IDevice

This class encapsulates and extends the ROS resource type ALIYUN::IOT::Device.

Initializers

import com.aliyun.ros.cdk.iot.Device;
Device.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .productKey(java.lang.String)
    .productKey(IResolvable)
//  .devEui(java.lang.String)
//  .devEui(IResolvable)
//  .deviceName(java.lang.String)
//  .deviceName(IResolvable)
//  .iotInstanceId(java.lang.String)
//  .iotInstanceId(IResolvable)
//  .nickname(java.lang.String)
//  .nickname(IResolvable)
//  .pinCode(java.lang.String)
//  .pinCode(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

productKey^Required

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

Property productKey: The identifier of the product to which the device to be registered belongs.

devEui^Optional

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

Property devEui: The DevEUI of the LoRaWAN device.

This parameter is required when you create a LoRaWAN device.

deviceName^Optional

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

Property deviceName: The DeviceName of the device.

The name must be 4 to 32 characters in length, and can contain letters, digits, hyphens (-), underscores (_), at signs (@), periods (.), and colons (:). You can use a combination of the DeviceName and ProductKey parameters to identify a device.

If you do not specify this parameter, IoT Platform randomly generates a DeviceName.

iotInstanceId^Optional

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

Property iotInstanceId: The ID of the instance.

You can view the instance ID on the Overview page in the IoT Platform console.

• If your instance has an ID, you must configure this parameter. If you do not set this parameter, the call fails.
• If your instance has no Overview page or ID, you do not need to set this parameter.

nickname^Optional

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

Property nickname: The alias of the device.

The alias must be 4 to 64 characters in length, and can contain letters, digits, and underscores (_).

If you do not specify this parameter, IoT Platform does not generate an alias for the device.

pinCode^Optional

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

Property pinCode: The PIN code of the LoRaWAN device.

This parameter is used to verify the DevEUI. When you create a LoRaWAN device, set LoraNodeType to CUSTOMDEFINED. This parameter is required.

Methods

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.

session^Required

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

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

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

addCount

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

count^Required

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

addDependency

public void addDependency(Resource resource)

resource^Required

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

name^Required

• Type: java.lang.String

setMetadata

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

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.iot.Device;
Device.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

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

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

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

attrDeviceName^Required

public java.lang.Object getAttrDeviceName();

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

Attribute DeviceName: Device name.

attrDeviceSecret^Required

public java.lang.Object getAttrDeviceSecret();

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

Attribute DeviceSecret: Device key.

attrIotId^Required

public java.lang.Object getAttrIotId();

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

Attribute IotId: Things internet device ID issued for the device, as the unique identifier of the device.

Description Keep, do not leak.

attrIotInstanceId^Required

public java.lang.Object getAttrIotInstanceId();

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

Attribute IotInstanceId: IOT instance ID.

attrIpAddress^Required

public java.lang.Object getAttrIpAddress();

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

Attribute IpAddress: IP address.

attrNickName^Required

public java.lang.Object getAttrNickName();

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

Attribute NickName: Nick name.

attrNodeType^Required

public java.lang.Object getAttrNodeType();

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

Attribute NodeType: Node type.

attrProductKey^Required

public java.lang.Object getAttrProductKey();

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

Attribute ProductKey: Product key.

attrProductName^Required

public java.lang.Object getAttrProductName();

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

Attribute ProductName: Product name.

props^Required

public DeviceProps getProps();

• Type: DeviceProps