Skip to content

Device

This class encapsulates and extends the ROS resource type ALIYUN::IOT::Device, which is used to register a Device.

Initializers

import { Device } from '@alicloud/ros-cdk-iot'
new Device(scope: Construct, id: string, props: DeviceProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props DeviceProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

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.
getAtt No description.
setMetadata No description.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct

import { Device } from '@alicloud/ros-cdk-iot'
Device.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrDeviceName @alicloud/ros-cdk-core.IResolvable Attribute DeviceName: Device name.
attrDeviceSecret @alicloud/ros-cdk-core.IResolvable Attribute DeviceSecret: Device key.
attrIotId @alicloud/ros-cdk-core.IResolvable Attribute IotId: Things internet device ID issued for the device, as the unique identifier of the device.
attrIotInstanceId @alicloud/ros-cdk-core.IResolvable Attribute IotInstanceId: IOT instance ID.
attrIpAddress @alicloud/ros-cdk-core.IResolvable Attribute IpAddress: IP address.
attrNickName @alicloud/ros-cdk-core.IResolvable Attribute NickName: Nick name.
attrNodeType @alicloud/ros-cdk-core.IResolvable Attribute NodeType: Node type.
attrProductKey @alicloud/ros-cdk-core.IResolvable Attribute ProductKey: Product key.
attrProductName @alicloud/ros-cdk-core.IResolvable Attribute ProductName: Product name.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrDeviceNameRequired

public readonly attrDeviceName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DeviceName: Device name.


attrDeviceSecretRequired

public readonly attrDeviceSecret: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DeviceSecret: Device key.


attrIotIdRequired

public readonly attrIotId: IResolvable;
  • Type: @alicloud/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.


attrIotInstanceIdRequired

public readonly attrIotInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IotInstanceId: IOT instance ID.


attrIpAddressRequired

public readonly attrIpAddress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IpAddress: IP address.


attrNickNameRequired

public readonly attrNickName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NickName: Nick name.


attrNodeTypeRequired

public readonly attrNodeType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute NodeType: Node type.


attrProductKeyRequired

public readonly attrProductKey: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ProductKey: Product key.


attrProductNameRequired

public readonly attrProductName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ProductName: Product name.