Skip to content

Product

This class encapsulates and extends the ROS resource type ALIYUN::IOT::Product, which is used to create a product.

Initializers 

import ros_cdk_iot
ros_cdk_iot.Product(
  scope: Construct,
  id: str,
  node_type: typing.Union[typing.Union[int, float], IResolvable],
  product_name: typing.Union[str, IResolvable],
  aliyun_commodity_code: typing.Union[str, IResolvable] = None,
  auth_type: typing.Union[str, IResolvable] = None,
  category_key: typing.Union[str, IResolvable] = None,
  data_format: typing.Union[typing.Union[int, float], IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  id2: typing.Union[bool, IResolvable] = None,
  iot_instance_id: typing.Union[str, IResolvable] = None,
  join_permission_id: typing.Union[str, IResolvable] = None,
  net_type: typing.Union[str, IResolvable] = None,
  protocol_type: typing.Union[str, IResolvable] = None,
  publish_auto: typing.Union[bool, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
node_type typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property nodeType: The node type of the product.
product_name typing.Union[str, ros_cdk_core.IResolvable] Property productName: The name of the product.
aliyun_commodity_code typing.Union[str, ros_cdk_core.IResolvable] Property aliyunCommodityCode: The edition of the product that you want to create.
auth_type typing.Union[str, ros_cdk_core.IResolvable] Property authType: Authentication device to access the Internet of Things platform under the product.
category_key typing.Union[str, ros_cdk_core.IResolvable] Property categoryKey: Identifier Product category.
data_format typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property dataFormat: You must specify this parameter if the value of AliyunCommodityCode is iothub_senior.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: A description of the product.
id2 typing.Union[bool, ros_cdk_core.IResolvable] Property id2: Whether ID2 certification.
iot_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property iotInstanceId: Public instance does not pass this parameter;
join_permission_id typing.Union[str, ros_cdk_core.IResolvable] Property joinPermissionId: LoRaWAN network credential ID.
net_type typing.Union[str, ros_cdk_core.IResolvable] Property netType: Networking mode.
protocol_type typing.Union[str, ros_cdk_core.IResolvable] Property protocolType: The protocol that devices of this product use to connect to gateways.
publish_auto typing.Union[bool, ros_cdk_core.IResolvable] Property publishAuto: Whether to automatically model publication after the product is created.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group ID (group ID to view the resource in the resource management console), specify the product is classified as a resource group.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

node_typeRequired

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

Property nodeType: The node type of the product.

Values: 0: Device. A device cannot be mounted with sub-devices. It can connect to IoT Platform either directly or as a sub-device of a gateway. 1: Gateway. A gateway can be mounted with sub-devices. It can manage sub-devices, maintain the topological relationships with sub-devices, and synchronize the topological relationships to IoT Platform.

product_nameRequired

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

Property productName: The name of the product.

A product name can be 4 to 30 characters in length and can contain Chinese characters, English letters, digits, and underscores (_). Note A product name must be unique in an account.

aliyun_commodity_codeOptional

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

Property aliyunCommodityCode: The edition of the product that you want to create.

There are two options: iothub_senior: Pro Edition. iothub: Basic Edition. If you do not input this parameter, the default value is used, which is iothub (Basic Edition).

auth_typeOptional

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

Property authType: Authentication device to access the Internet of Things platform under the product.

Optional: secret: using a device key for device authentication. Details can be found MQTT-TCP connection communication. id2: Use things device authentication ID. x509: X.509 certificates using the device for device authentication. The use of X.509 certificates device side configuration instructions, see Using X.509 certificate authentication. If this parameter is passed, the default value is secret.

category_keyOptional

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

Property categoryKey: Identifier Product category.

If you pass this parameter, the product will be created using the object model specified category; not passed, the standard model is not used in any category. Call ListThingTemplates, view of things platform predefined category information from the returned results, get the value of CategoryKey.

data_formatOptional

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

Property dataFormat: You must specify this parameter if the value of AliyunCommodityCode is iothub_senior.

This parameter is only available and required when you create a Pro Edition product. Options: 0: Do not parse/Custom. 1: Alink JSON.

descriptionOptional

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

Property description: A description of the product.

The description can be a maximum of 100 characters in length.

id2Optional

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

Property id2: Whether ID2 certification.

Optional values: true: the opening of ID2 certification. false: do not open ID2 certification. Do not pass this parameter, the default is not opened. Explanation Only 2 East China (Shanghai) regional support ID2 authentication. If this parameter value is set to true, but passed AuthType parameter value is not id2, the system will AuthType parameter values prevail.

iot_instance_idOptional

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

Property iotInstanceId: Public instance does not pass this parameter;

instance that you need to buy the incoming instance ID.

join_permission_idOptional

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

Property joinPermissionId: LoRaWAN network credential ID.

When networking mode NetType chosen LORA, the necessary parameters. Please call QueryLoRaJoinPermissions query JoinPermissionId network credentials LoRaWAN under your account. If you do not LoRaWAN network credentials, visit the network management platform to create things together.

net_typeOptional

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

Property netType: Networking mode.

Set this parameter only if you are creating a product whose devices directly connect to IoT Platform. Options: WIFI CELLULAR ETHERNET OTHER The default value is WIFI.

protocol_typeOptional

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

Property protocolType: The protocol that devices of this product use to connect to gateways.

Set this parameter only if you are creating a product whose devices will be connected to gateways. Options: modbus: Modbus. opc-ua: OPC UA. customize: Customized protocol. ble: BLE. zigbee: ZigBee.

publish_autoOptional

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

Property publishAuto: Whether to automatically model publication after the product is created.

true: publishing. false: not released. This parameter is not passed, the default value true.

resource_group_idOptional

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

Property resourceGroupId: Resource group ID (group ID to view the resource in the resource management console), specify the product is classified as a resource group.

If this parameter is passed, the product will be classified as a default resource group.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_iot_instance_id ros_cdk_core.IResolvable Attribute IotInstanceId: IOT instance ID.
attr_product_key ros_cdk_core.IResolvable Attribute ProductKey: The globally unique identifier of the product issued by IoT Platform.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_iot_instance_idRequired 

attr_iot_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IotInstanceId: IOT instance ID.

attr_product_keyRequired 

attr_product_key: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ProductKey: The globally unique identifier of the product issued by IoT Platform.