ALIYUN::IOT::Product は、製品を作成するために使用されます。
次のリージョンで製品を作成できます:
- 上海
- シンガポール (シンガポール)
- 日本 (東京)
- ドイツ (フランクフルト)
- 米国 (シリコンバレー)
- 米国 (バージニア)
構文
{
"Type": "ALIYUN::IOT::Product",
"Properties": {
"AuthType": String,
"NodeType": Integer,
"Description": String,
"CategoryKey": String,
"IotInstanceId": String,
"ProtocolType": String,
"PublishAuto": Boolean,
"Id2": Boolean,
"ProductName": String,
"ResourceGroupId": String,
"DataFormat": Integer,
"AliyunCommodityCode": String,
"JoinPermissionId": String,
"NetType": String
}
}プロパティ
| パラメーター | タイプ | 必須 | 編集可能 | 説明 | 制約 |
| AuthType | String | いいえ | リリース済み | 製品のデバイスがIoTプラットフォームにアクセスするための認証タイプ。 | 有効な値:
|
| NodeType | Integer | はい | サポートされていません | 製品のノードタイプ。 | このパラメーターは、AliyunCommodityCode=iothub_senior の場合にのみ使用できます。 有効な値:
|
| Description | String | サポートされていません | サポートされています | 製品の説明情報 | なし |
| CategoryKey | String | いいえ | リリース済み | 製品カテゴリの識別子。 | このパラメーターを指定すると、作成された製品は指定されたカテゴリのTSLを使用します。このパラメーターを指定しない場合、どのカテゴリの標準TSLも使用されません。 |
| IotInstanceId | String | いいえ | リリース済み | インスタンスのID。 | パブリックインスタンスでは、このパラメーターは不要です。 |
| ProtocolType | String | いいえ | リリース済み | デバイスがゲートウェイに接続されているときのプロトコルタイプ。 | AliyunCommodityCode=iothub_senior のデバイスをゲートウェイ経由で IoT プラットフォームに接続する場合、このパラメーターを指定する必要があります。 有効な値:
|
| PublishAuto | Boolean | 削除済み | リリース済み | 製品の作成後にTSLを自動的に公開するかどうかを示します。 | 有効な値:
|
| Id2 | Boolean | 削除済み | リリース済み | id²認証を使用するかどうか | 有効な値:
|
| ProductName | String | はい | はい | 製品名 | 名前は 4 ～ 30 文字で、漢字、大文字、小文字、数字、アンダースコア (_) を使用できます。 説明 1 つの漢字は 2 文字としてカウントされます。 |
| ResourceGroupId | String | いいえ | はい | リソースグループのID。 | なし |
| DataFormat | Integer | 削除済み | リリース済み | 製品タイプのデータ形式 | このパラメーターは AliyunCommodityCode=iothub_senior の場合にのみ使用できます。有効な値:
|
| AliyunCommodityCode | String | いいえ | リリース済み | 製品タイプ | 有効な値:
|
| JoinPermissionId | String | いいえ | リリース済み | LoRaWANイングレス資格情報ID | NetType パラメーターを LORA に設定した場合、このパラメーターは必須です。 |
| NetType | String | いいえ | リリース済み | ネットワーク接続方法 | AliyunCommodityCode=iothub_senior を使用していて、この製品のデバイスがゲートウェイであるか、ゲートウェイに接続されていないデバイスである場合、このパラメーターを指定する必要があります。 有効な値:
|
戻り値
Fn::GetAtt
- ProductKey: 製品識別子。
- IotInstanceId: インスタンスのID。
例
JSON 形式
{
"ROSTemplateFormatVersion": "2015-09-01",
"Resources": {
"Product": {
"Type": "ALIYUN::IOT::Product",
"Properties": {
"AuthType": {
"Ref": "AuthType"
},
"NodeType": {
"Ref": "NodeType"
},
"Description": {
"Ref": "Description"
},
"CategoryKey": {
"Ref": "CategoryKey"
},
"IotInstanceId": {
"Ref": "IotInstanceId"
},
"ProtocolType": {
"Ref": "ProtocolType"
},
"PublishAuto": {
"Ref": "PublishAuto"
},
"Id2": {
"Ref": "Id2"
},
"ProductName": {
"Ref": "ProductName"
},
"ResourceGroupId": {
"Ref": "ResourceGroupId"
},
"DataFormat": {
"Ref": "DataFormat"
},
"AliyunCommodityCode": {
"Ref": "AliyunCommodityCode"
},
"JoinPermissionId": {
"Ref": "JoinPermissionId"
},
"NetType": {
"Ref": "NetType"
}
}
}
},
"Parameters": {
"AuthType": {
"Type": "String",
"Description": "製品配下のデバイスがモノのインターネットプラットフォームにアクセスするための認証。オプション：\nsecret：デバイスキーを使用してデバイス認証を行います。\n詳細は、MQTT-TCP接続通信をご覧ください。\nid2：モノのデバイス認証IDを使用します。\nx509：デバイス認証にデバイスのX.509証明書を使用します。\nX.509証明書を使用したデバイス側の設定手順については、「X.509証明書認証の使用」を参照してください。\nこのパラメーターが渡された場合、デフォルト値はsecretです。" // 翻訳済みのコメント
},
"NodeType": {
"Type": "Number",
"Description": "製品のノードタイプ。値：\n0：デバイス。デバイスにはサブデバイスを搭載できません。IoTプラットフォームに直接接続することも、ゲートウェイのサブデバイスとして接続することもできます。\n1：ゲートウェイ。ゲートウェイにはサブデバイスを搭載できます。サブデバイスを管理し、サブデバイスとのトポロジ関係を維持し、トポロジ関係をIoTプラットフォームに同期できます。" // 翻訳済みのコメント
},
"Description": {
"Type": "String",
"Description": "製品の説明。説明は最大100文字です。" // 翻訳済みのコメント
},
"CategoryKey": {
"Type": "String",
"Description": "製品カテゴリの識別子。このパラメーターを渡すと、指定されたカテゴリのオブジェクトモデルを使用して製品が作成されます。渡されない場合、標準モデルはいずれのカテゴリでも使用されません。\nListThingTemplatesを呼び出し、返された結果からモノのプラットフォームの定義済みカテゴリ情報を表示し、CategoryKeyの値を取得します。" // 翻訳済みのコメント
},
"IotInstanceId": {
"Type": "String",
"Description": "パブリックインスタンスはこのパラメーターを渡しません。購入したインスタンスのインスタンスIDを入力する必要があります。" // 翻訳済みのコメント
},
"ProtocolType": {
"Type": "String",
"Description": "この製品のデバイスがゲートウェイに接続するために使用するプロトコル。\nデバイスがゲートウェイに接続される製品を作成する場合にのみ、このパラメーターを設定します。\nオプション：\nmodbus：Modbus。\nopc-ua：OPC UA。\ncustomize：カスタマイズされたプロトコル。\nble：BLE。\nzigbee：ZigBee。" // 翻訳済みのコメント
},
"PublishAuto": {
"Type": "Boolean",
"Description": "製品の作成後にモデルを自動的に公開するかどうか。\ntrue：公開する。\nfalse：公開しない。\nこのパラメーターが渡されない場合、デフォルト値はtrueです。" // 翻訳済みのコメント
},
"Id2": {
"Type": "Boolean",
"Description": "ID2認証を行うかどうか。\nオプション値：\ntrue：ID2認証を開きます。\nfalse：ID2認証を開きません。\nこのパラメーターを渡さない場合、デフォルトでは開きません。\n説明\n華東2（上海）リージョンのみがID2認証をサポートしています。\nこのパラメーター値がtrueに設定されているが、渡されたAuthTypeパラメーター値がid2でない場合、システムはAuthTypeパラメーター値を優先します。" // 翻訳済みのコメント
},
"ProductName": {
"Type": "String",
"Description": "製品の名前。製品名は4～30文字で、漢字、英字、数字、アンダースコア(_)を含めることができます。\n注：製品名はアカウント内で一意である必要があります。" // 翻訳済みのコメント
},
"ResourceGroupId": {
"Type": "String",
"Description": "リソースグループID（リソース管理コンソールでリソースを表示するためのグループID）。製品を分類するリソースグループを指定します。\nこのパラメーターが渡されると、製品はデフォルトのリソースグループに分類されます。" // 翻訳済みのコメント
},
"DataFormat": {
"Type": "Number",
"Description": "AliyunCommodityCodeの値がiothub_seniorの場合は、このパラメーターを指定する必要があります。\nこのパラメーターは、Pro Edition製品を作成する場合にのみ使用可能で必須です。\nオプション：\n0：解析しない/カスタム。\n1：Alink JSON。" // 翻訳済みのコメント
},
"AliyunCommodityCode": {
"Type": "String",
"Description": "作成する製品のエディション。2つのオプションがあります。\niothub_senior：Pro Edition。\niothub：Basic Edition。\nこのパラメーターを入力しない場合、デフォルト値であるiothub（Basic Edition）が使用されます。" // 翻訳済みのコメント
},
"JoinPermissionId": {
"Type": "String",
"Description": "LoRaWANネットワーク資格情報ID。ネットワークモードNetTypeでLORAを選択した場合、必須パラメーターです。\nQueryLoRaJoinPermissionsを呼び出して、アカウント配下のLoRaWANネットワーク資格情報のJoinPermissionIdをクエリしてください。\nLoRaWANネットワーク資格情報がない場合は、ネットワーク管理プラットフォームにアクセスしてモノを作成してください。" // 翻訳済みのコメント
},
"NetType": {
"Type": "String",
"Description": "ネットワークモード。\nデバイスがIoTプラットフォームに直接接続する製品を作成する場合にのみ、このパラメーターを設定します。\nオプション：\nWi-Fi\nCELLULAR\nETHERNET\nOTHER\nデフォルト値はWIFIです。" // 翻訳済みのコメント
}
},
"Outputs": {
"ProductKey": {
"Description": "IoTプラットフォームによって発行された製品のグローバルに一意の識別子。", // 翻訳済みのコメント
"Value": {
"Fn::GetAtt": [
"Product",
"ProductKey"
]
}
},
"IotInstanceId": {
"Description": "IOTインスタンスID。", // 翻訳済みのコメント
"Value": {
"Fn::GetAtt": [
"Product",
"IotInstanceId"
]
}
}
}
}YAML 形式
ROSTemplateFormatVersion: '2015-09-01'
Resources:
Product:
Type: 'ALIYUN::IOT::Product'
Properties:
AuthType:
Ref: AuthType
NodeType:
Ref: NodeType
Description:
Ref: Description
CategoryKey:
Ref: CategoryKey
IotInstanceId:
Ref: IotInstanceId
ProtocolType:
Ref: ProtocolType
PublishAuto:
Ref: PublishAuto
Id2:
Ref: Id2
ProductName:
Ref: ProductName
ResourceGroupId:
Ref: ResourceGroupId
DataFormat:
Ref: DataFormat
AliyunCommodityCode:
Ref: AliyunCommodityCode
JoinPermissionId:
Ref: JoinPermissionId
NetType:
Ref: NetType
Parameters:
AuthType:
Type: String
Description: >-
製品配下のデバイスがモノのインターネットプラットフォームにアクセスするための認証。オプション：
secret：デバイスキーを使用してデバイス認証を行います。
詳細は、MQTT-TCP接続通信をご覧ください。
id2：モノのデバイス認証IDを使用します。
x509：デバイス認証にデバイスのX.509証明書を使用します。
X.509証明書を使用したデバイス側の設定手順については、「X.509証明書認証の使用」を参照してください。
このパラメーターが渡された場合、デフォルト値はsecretです。
NodeType:
Type: Number
Description: >-
製品のノードタイプ。値：
0：デバイス。デバイスにはサブデバイスを搭載できません。IoTプラットフォームに直接接続することも、
ゲートウェイのサブデバイスとして接続することもできます。
1：ゲートウェイ。ゲートウェイにはサブデバイスを搭載できます。サブデバイスを管理し、
サブデバイスとのトポロジ関係を維持し、トポロジ関係を
IoTプラットフォームに同期できます。
AllowedValues:
-0
- 1
Description:
Type: String
Description: >-
製品の説明。説明は最大100文字です。
CategoryKey:
Type: String
Description: >-
製品カテゴリの識別子。このパラメーターを渡すと、指定されたカテゴリのオブジェクトモデルを使用して製品が作成されます。渡されない場合、
標準モデルはいずれのカテゴリでも使用されません。
ListThingTemplatesを呼び出し、モノのプラットフォームの定義済みカテゴリ情報を表示し、CategoryKeyの値を取得します。
IotInstanceId:
Type: String
Description: >-
パブリックインスタンスはこのパラメーターを渡しません。購入したインスタンスIDを入力する必要があります。
ProtocolType:
Type: String
Description: >-
この製品のデバイスがゲートウェイに接続するために使用するプロトコル。
デバイスがゲートウェイに接続される製品を作成する場合にのみ、このパラメーターを設定します。
オプション：
modbus：Modbus。
opc-ua：OPC UA。
customize：カスタマイズされたプロトコル。
ble：BLE。
zigbee：ZigBee。
AllowedValues:
-ble
-customize
-modbus
-opc-ua
-zigbee
PublishAuto:
Type: Boolean
Description: |-
製品の作成後にモデルを自動的に公開するかどうか。
true：公開する。
false：公開しない。
このパラメーターが渡されない場合、デフォルト値はtrueです。
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
Id2:
Type: Boolean
Description: >-
ID2認証を行うかどうか。
オプション値：
true：ID2認証を開きます。
false：ID2認証を開きません。
このパラメーターを渡さない場合、デフォルトでは開きません。
説明
華東2（上海）リージョンのみがID2認証をサポートしています。
このパラメーター値がtrueに設定されているが、渡されたAuthTypeパラメーター値がid2でない場合、システムはAuthTypeパラメーター値を優先します。
AllowedValues:
- 'True'
- 'true'
- 'False'
- 'false'
ProductName:
Type: String
Description: >-
製品の名前。製品名は4～30文字で、
漢字、英字、数字、アンダースコア(_)を含めることができます。
注：製品名はアカウント内で一意である必要があります。
ResourceGroupId:
Type: String
Description: >-
リソースグループID（リソース管理コンソールでリソースを表示するためのグループID）。製品を分類するリソースグループを指定します。
このパラメーターが渡されると、製品はデフォルトのリソースグループに分類されます。
DataFormat:
Type: Number
Description: >-
AliyunCommodityCodeの値がiothub_seniorの場合は、このパラメーターを指定する必要があります。
このパラメーターは、Pro Edition製品を作成する場合にのみ使用可能で必須です。
オプション：
0：解析しない/カスタム。
1：Alink JSON。
AllowedValues:
-0
- 1
AliyunCommodityCode:
Type: String
Description: >-
作成する製品のエディション。2つのオプションがあります。
iothub_senior：Pro Edition。
iothub：Basic Edition。
このパラメーターを入力しない場合、デフォルト値であるiothub（Basic
Edition）が使用されます。
JoinPermissionId:
Type: String
Description: >-
LoRaWANネットワーク資格情報ID。ネットワークモードNetTypeでLORAを選択した場合、必須パラメーターです。
QueryLoRaJoinPermissionsを呼び出して、アカウント配下のLoRaWANネットワーク資格情報のJoinPermissionIdをクエリしてください。
LoRaWANネットワーク資格情報がない場合、ネットワーク管理プラットフォームにアクセスしてモノを作成してください。
NetType:
Type: String
Description: >-
ネットワークモード。
デバイスがIoTプラットフォームに直接接続する製品を作成する場合にのみ、このパラメーターを設定します。
オプション：
Wi-Fi
CELLULAR
ETHERNET
OTHER
デフォルト値はWIFIです。
AllowedValues:
-CELLULAR
-ETHERNET
-LORA
-OTHER
-WIFI
Outputs:
ProductKey:
Description: IoTプラットフォームによって発行された製品のグローバルに一意の識別子。
Value:
'Fn::GetAtt':
-Product
-ProductKey
IotInstanceId:
Description: IOTインスタンスID。
Value:
'Fn::GetAtt':
-Product
-IotInstanceId