Device

• Implements: IDevice

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

Initializers

import ros_cdk_iot
ros_cdk_iot.Device(
  scope: Construct,
  id: str,
  product_key: typing.Union[str, IResolvable],
  dev_eui: typing.Union[str, IResolvable] = None,
  device_name: typing.Union[str, IResolvable] = None,
  iot_instance_id: typing.Union[str, IResolvable] = None,
  nickname: typing.Union[str, IResolvable] = None,
  pin_code: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

product_key^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

dev_eui^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property devEui: The DevEUI of the LoRaWAN device.

This parameter is required when you create a LoRaWAN device.

device_name^Optional

• Type: typing.Union[str, 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.

iot_instance_id^Optional

• Type: typing.Union[str, 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: typing.Union[str, 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.

pin_code^Optional

• Type: typing.Union[str, 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_iot
ros_cdk_iot.Device.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_device_name^Required

attr_device_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute DeviceName: Device name.

attr_device_secret^Required

attr_device_secret: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute DeviceSecret: Device key.

attr_iot_id^Required

attr_iot_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

attr_iot_instance_id^Required

attr_iot_instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute IotInstanceId: IOT instance ID.

attr_ip_address^Required

attr_ip_address: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute IpAddress: IP address.

attr_nick_name^Required

attr_nick_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute NickName: Nick name.

attr_node_type^Required

attr_node_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute NodeType: Node type.

attr_product_key^Required

attr_product_key: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ProductKey: Product key.

attr_product_name^Required

attr_product_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute ProductName: Product name.

props^Required

props: DeviceProps

• Type: DeviceProps