シャドウマネージャー - AWS IoT Greengrass

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

シャドウマネージャー

シャドウマネージャーコンポーネント (aws.greengrass.ShadowManager) を使用すると、コアデバイスでローカルシャドウサービスを有効にできます。ローカルシャドウサービスを使用すると、コンポーネントはプロセス間通信を使用してローカルシャドウとやり取りすることができます。シャドウマネージャーコンポーネントは、ローカルシャドウドキュメントのストレージを管理し、ローカルシャドウ状態の AWS IoT Device Shadow サービスとの同期も処理します。

Greengrass コアデバイスがシャドウとやり取りする方法の詳細については、「デバイスシャドウとやり取り」を参照してください。

バージョン

このコンポーネントには、次のバージョンがあります。

  • 2.3.x

  • 2.2.x

  • 2.1.x

  • 2.0.x

タイプ

このコンポーネントはプラグインコンポーネント (aws.greengrass.plugin) です。Greengrass nucleus は、nucleus と同じ Java 仮想マシン (JVM) でこのコンポーネントを実行します。コアデバイスでこのコンポーネントのバージョンを変更するとき、nucleus が再起動します。

このコンポーネントは、Greengrass nucleus と同じログファイルを使用します。詳細については、「AWS IoT Greengrass ログのモニタリング」を参照してください。

詳細については、「コンポーネントタイプ」を参照してください。

オペレーティングシステム

このコンポーネントは、次のオペレーティングシステムを実行するコアデバイスにインストールできます。

  • Linux

  • Windows

要件

このコンポーネントには次の要件があります。

  • (オプション) シャドウを AWS IoT Device Shadow サービスに同期するには、Greengrass コアデバイスの AWS IoT ポリシーで次のシャド AWS IoT Core ウポリシーアクションを許可する必要があります。

    • iot:GetThingShadow

    • iot:UpdateThingShadow

    • iot:DeleteThingShadow

    これらの AWS IoT Core ポリシーの詳細については、「 AWS IoT デベロッパーガイド」の「 AWS IoT Core ポリシーアクション」を参照してください。

    最小 AWS IoT ポリシーの詳細については、「」を参照してください。 AWS IoT Greengrass V2 コアデバイス向けの最低限の AWS IoT ポリシー

  • シャドウマネージャーコンポーネントは、 での実行がサポートされていますVPC。

依存関係

コンポーネントをデプロイすると、 はその依存関係の互換性のあるバージョン AWS IoT Greengrass もデプロイします。つまり、コンポーネントを正常にデプロイするには、コンポーネントとその依存関係のすべての要件を満たす必要があります。このセクションでは、このコンポーネントのリリースされたバージョンの依存関係と、各依存関係に対するコンポーネントのバージョンを定義するセマンティックバージョン制約をリスト表示しています。コンポーネントの各バージョンの依存関係は、AWS IoT Greengrass コンソールでも確認できます。コンポーネントの詳細ページで [Dependencies] (依存関係) リストを確認します。

2.3.9

次の表に、このコンポーネントのバージョン 2.3.9 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.14.0 ソフト
2.3.5 – 2.3.8

次の表に、このコンポーネントのバージョン 2.3.5 から 2.3.8 までの依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.13.0 ソフト
2.3.3 and 2.3.4

次の表に、このコンポーネントのバージョン 2.3.3 および 2.3.4 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.12.0 ソフト
2.3.2

次の表に、このコンポーネントのバージョン 2.3.2 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.11.0 ソフト
2.3.0 and 2.3.1

次の表に、このコンポーネントのバージョン 2.3.0 および 2.3.1 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.5.0 <2.10.0 ソフト
2.2.3 and 2.2.4

次の表に、このコンポーネントのバージョン 2.2.3 および 2.2.4 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.2.0 <3.0.0 ソフト
2.2.2

次の表に、このコンポーネントのバージョン 2.2.2 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.2.0 <2.9.0 ソフト
2.2.1

次の表に、このコンポーネントのバージョン 2.2.1 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.2.0 <2.8.0 ソフト
2.1.1 and 2.2.0

次の表に、このコンポーネントのバージョン 2.1.1 および 2.2.0 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.2.0 <2.7.0 ソフト
2.0.5 - 2.1.0

次の表に、このコンポーネントのバージョン 2.0.5 から 2.1.0 までの依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.2.0 <2.6.0 ソフト
2.0.3 and 2.0.4

次の表に、このコンポーネントのバージョン 2.0.3 および 2.0.4 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.2.0 <2.5.0 ソフト
2.0.1 and 2.0.2

次の表に、このコンポーネントのバージョン 2.0.1 および 2.0.2 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.2.0 <2.4.0 ソフト
2.0.0

次の表に、このコンポーネントのバージョン 2.0.0 の依存関係を示します。

依存関係 互換性のあるバージョン 依存関係タイプ
Greengrass nucleus >=2.2.0 <2.3.0 ソフト

コンポーネントの依存関係の詳細については、「コンポーネント recipe のリファレンス」を参照してください。

構成

このコンポーネントには、コンポーネントのデプロイ時にカスタマイズできる次の設定パラメータが用意されています。

2.3.x
strategy

(オプション) このコンポーネントが AWS IoT Core とコアデバイス間でシャドウを同期するために使用する戦略。

このオブジェクトには、次の情報が含まれます。

type

(オプション) このコンポーネントが AWS IoT Core とコアデバイス間でシャドウを同期させるために使用する戦略のタイプ。次のオプションから選択します。

  • realTime – シャドウの更新が発生する AWS IoT Core たびに、シャドウを と同期します。

  • periodicdelay設定パラメータ AWS IoT Core で指定した一定の間隔でシャドウを と同期します。

デフォルト: realTime

delay

(オプション) periodic 同期戦略を指定した場合に、このコンポーネントがシャドウを AWS IoT Coreと同期する間隔 (秒単位)。

注記

periodic 同期戦略を指定する場合、このパラメータは必須です。

synchronize

(オプション) シャドウを AWS クラウドと同期する方法を決定する同期設定。

注記

シャドウを AWS クラウドと同期させるには、このプロパティを使用して設定アップデートを作成する必要があります。

このオブジェクトには、次の情報が含まれます。

coreThing

(オプション) 同期するコアデバイスシャドウ。このオブジェクトには、次の情報が含まれます。

classic

(オプション) デフォルトでは、シャドウマネージャーはコアデバイスのクラシックシャドウのローカル状態を AWS クラウドと同期させます。クラシックデバイスシャドウを同期しない場合は、これを false に設定します。

デフォルト: true

namedShadows

(オプション) 同期する名前付きコアデバイスシャドウのリスト。シャドウの正確な名前を指定する必要があります。

警告

この AWS IoT Greengrass サービスは、AWSManagedGreengrassV2Deployment名前付きシャドウを使用して、個々のコアデバイスをターゲットとするデプロイを管理します。この名前付きシャドウは、 AWS IoT Greengrass サービスが使用するために予約されています。この名前付きシャドウを更新または削除しないでください。

shadowDocumentsMap

(オプション) 同期する追加のデバイスシャドウ。この構成パラメータを使用すると、シャドウドキュメントの指定が簡単になります。shadowDocuments オブジェクトの代わりに、このパラメータを使用することをお勧めします。

注記

shadowDocumentsMap オブジェクトを指定する場合は、shadowDocuments オブジェクトを指定しないでください。

各オブジェクトには、次の情報が含まれます:

thingName

のシャドウ設定 thingName このシャドウ設定の 。

classic

(オプション) thingName デバイスのクラシックデバイスシャドウを同期しない場合は、これを false に設定します。

namedShadows

同期する名前付きシャドウのリスト。シャドウの正確な名前を指定する必要があります。

shadowDocuments

(オプション) 同期する追加のデバイスシャドウのリスト。代わりに shadowDocumentsMap パラメータを使用することをお勧めします。

注記

shadowDocuments オブジェクトを指定する場合は、shadowDocumentsMap オブジェクトを指定しないでください。

このリストの各オブジェクトには、次の情報が含まれます。

thingName

シャドウを同期するデバイスのモノの名前。

classic

(オプション) thingName デバイスのクラシックデバイスシャドウを同期しない場合は、これを false に設定します。

デフォルト: true

namedShadows

(オプション) 同期する名前付きデバイスシャドウのリスト。シャドウの正確な名前を指定する必要があります。

direction

(オプション) ローカルシャドウサービスと AWS クラウドの間でシャドウを同期させる方向。このオプションを設定すると、 AWS クラウドへの帯域幅と接続数を低減できます。次のオプションから選択します。

  • betweenDeviceAndCloud – ローカルシャドウサービスと AWS クラウドを同期させる。

  • deviceToCloud – ローカルシャドウサービスから にシャドウ更新を送信し AWS クラウド、 からシャドウ更新を無視します AWS クラウド。

  • cloudToDevice – AWS クラウドからシャドウアップデートを受信し、ローカルシャドウサービスから AWS クラウドにシャドウアップデートを送信しない。

デフォルト: BETWEEN_DEVICE_AND_CLOUD

rateLimits

(オプション) シャドウサービス要求のレート制限を決定する設定。

このオブジェクトには、次の情報が含まれます。

maxOutboundSyncUpdatesPerSecond

(オプション) デバイスが送信する 1 秒あたりの同期要求の最大数。

デフォルト: 100 要求/秒

maxTotalLocalRequestsRate

(オプション) コアデバイスに送信される 1 秒あたりのローカルIPCリクエストの最大数。

デフォルト: 200 要求/秒

maxLocalRequestsPerSecondPerThing

(オプション) 接続された IoT モノごとに送信される 1 秒あたりのローカルIPCリクエストの最大数。

デフォルト: 1 件につき 20 要求/秒

注記

これらのレート制限パラメータは、ローカルシャドウサービスの 1 秒あたりの最大要求数を定義します。 AWS IoT Device Shadow サービスの 1 秒あたりの最大リクエスト数は、 によって異なります AWS リージョン。詳細については、「」のAWS IoT 「 Device Shadow Service API の制限」を参照してくださいAmazon Web Services 全般のリファレンス

shadowDocumentSizeLimitBytes

(オプション) ローカルシャドウの各JSONステートドキュメントの最大許容サイズ。

この値を増やす場合は、クラウドシャドウの JSON 状態ドキュメントのリソース制限も引き上げる必要があります。詳細については、「」のAWS IoT 「 Device Shadow Service API の制限」を参照してくださいAmazon Web Services 全般のリファレンス

デフォルト: 8,192 バイト

最大: 30720 バイト

例: 設定マージの更新

次の例は、シャドウマネージャーコンポーネントで利用可能なすべての設定パラメータを使用した設定マージ更新のサンプルを示しています。

{ "strategy":{ "type":"periodic", "delay":300 }, "synchronize":{ "shadowDocumentsMap":{ "MyDevice1":{ "classic":false, "namedShadows":[ "MyShadowA", "MyShadowB" ] }, "MyDevice2":{ "classic":true, "namedShadows":[] } }, "direction":"betweenDeviceAndCloud" }, "rateLimits":{ "maxOutboundSyncUpdatesPerSecond":100, "maxTotalLocalRequestsRate":200, "maxLocalRequestsPerSecondPerThing":20 }, "shadowDocumentSizeLimitBytes":8192 }
2.2.x
strategy

(オプション) このコンポーネントが AWS IoT Core とコアデバイス間でシャドウを同期するために使用する戦略。

このオブジェクトには、次の情報が含まれます。

type

(オプション) このコンポーネントが AWS IoT Core とコアデバイス間でシャドウを同期させるために使用する戦略のタイプ。次のオプションから選択します。

  • realTime – シャドウの更新が発生する AWS IoT Core たびに、シャドウを と同期します。

  • periodicdelay設定パラメータ AWS IoT Core で指定した一定の間隔でシャドウを と同期します。

デフォルト: realTime

delay

(オプション) periodic 同期戦略を指定した場合に、このコンポーネントがシャドウを AWS IoT Coreと同期する間隔 (秒単位)。

注記

periodic 同期戦略を指定する場合、このパラメータは必須です。

synchronize

(オプション) シャドウを AWS クラウドと同期する方法を決定する同期設定。

注記

シャドウを AWS クラウドと同期させるには、このプロパティを使用して設定アップデートを作成する必要があります。

このオブジェクトには、次の情報が含まれます。

coreThing

(オプション) 同期するコアデバイスシャドウ。このオブジェクトには、次の情報が含まれます。

classic

(オプション) デフォルトでは、シャドウマネージャーはコアデバイスのクラシックシャドウのローカル状態を AWS クラウドと同期させます。クラシックデバイスシャドウを同期しない場合は、これを false に設定します。

デフォルト: true

namedShadows

(オプション) 同期する名前付きコアデバイスシャドウのリスト。シャドウの正確な名前を指定する必要があります。

警告

この AWS IoT Greengrass サービスは、AWSManagedGreengrassV2Deployment名前付きシャドウを使用して、個々のコアデバイスをターゲットとするデプロイを管理します。この名前付きシャドウは、 AWS IoT Greengrass サービスが使用するために予約されています。この名前付きシャドウを更新または削除しないでください。

shadowDocumentsMap

(オプション) 同期する追加のデバイスシャドウ。この構成パラメータを使用すると、シャドウドキュメントの指定が簡単になります。shadowDocuments オブジェクトの代わりに、このパラメータを使用することをお勧めします。

注記

shadowDocumentsMap オブジェクトを指定する場合は、shadowDocuments オブジェクトを指定しないでください。

各オブジェクトには、次の情報が含まれます:

thingName

のシャドウ設定 thingName このシャドウ設定の 。

classic

(オプション) thingName デバイスのクラシックデバイスシャドウを同期しない場合は、これを false に設定します。

namedShadows

同期する名前付きシャドウのリスト。シャドウの正確な名前を指定する必要があります。

shadowDocuments

(オプション) 同期する追加のデバイスシャドウのリスト。代わりに shadowDocumentsMap パラメータを使用することをお勧めします。

注記

shadowDocuments オブジェクトを指定する場合は、shadowDocumentsMap オブジェクトを指定しないでください。

このリストの各オブジェクトには、次の情報が含まれます。

thingName

シャドウを同期するデバイスのモノの名前。

classic

(オプション) thingName デバイスのクラシックデバイスシャドウを同期しない場合は、これを false に設定します。

デフォルト: true

namedShadows

(オプション) 同期する名前付きデバイスシャドウのリスト。シャドウの正確な名前を指定する必要があります。

direction

(オプション) ローカルシャドウサービスと AWS クラウドの間でシャドウを同期させる方向。このオプションを設定すると、 AWS クラウドへの帯域幅と接続数を低減できます。次のオプションから選択します。

  • betweenDeviceAndCloud – ローカルシャドウサービスと AWS クラウドを同期させる。

  • deviceToCloud – ローカルシャドウサービスから にシャドウ更新を送信し AWS クラウド、 からシャドウ更新を無視します AWS クラウド。

  • cloudToDevice – AWS クラウドからシャドウアップデートを受信し、ローカルシャドウサービスから AWS クラウドにシャドウアップデートを送信しない。

デフォルト: BETWEEN_DEVICE_AND_CLOUD

rateLimits

(オプション) シャドウサービス要求のレート制限を決定する設定。

このオブジェクトには、次の情報が含まれます。

maxOutboundSyncUpdatesPerSecond

(オプション) デバイスが送信する 1 秒あたりの同期要求の最大数。

デフォルト: 100 要求/秒

maxTotalLocalRequestsRate

(オプション) コアデバイスに送信される 1 秒あたりのローカルIPCリクエストの最大数。

デフォルト: 200 要求/秒

maxLocalRequestsPerSecondPerThing

(オプション) 接続された IoT モノごとに送信される 1 秒あたりのローカルIPCリクエストの最大数。

デフォルト: 1 件につき 20 要求/秒

注記

これらのレート制限パラメータは、ローカルシャドウサービスの 1 秒あたりの最大要求数を定義します。 AWS IoT Device Shadow サービスの 1 秒あたりの最大リクエスト数は、 によって異なります AWS リージョン。詳細については、「」のAWS IoT 「 Device Shadow Service API の制限」を参照してくださいAmazon Web Services 全般のリファレンス

shadowDocumentSizeLimitBytes

(オプション) ローカルシャドウの各JSONステートドキュメントの最大許容サイズ。

この値を増やす場合は、クラウドシャドウの JSON 状態ドキュメントのリソース制限も引き上げる必要があります。詳細については、「」のAWS IoT 「 Device Shadow Service API の制限」を参照してくださいAmazon Web Services 全般のリファレンス

デフォルト: 8,192 バイト

最大: 30720 バイト

例: 設定マージの更新

次の例は、シャドウマネージャーコンポーネントで利用可能なすべての設定パラメータを使用した設定マージ更新のサンプルを示しています。

{ "strategy":{ "type":"periodic", "delay":300 }, "synchronize":{ "shadowDocumentsMap":{ "MyDevice1":{ "classic":false, "namedShadows":[ "MyShadowA", "MyShadowB" ] }, "MyDevice2":{ "classic":true, "namedShadows":[] } }, "direction":"betweenDeviceAndCloud" }, "rateLimits":{ "maxOutboundSyncUpdatesPerSecond":100, "maxTotalLocalRequestsRate":200, "maxLocalRequestsPerSecondPerThing":20 }, "shadowDocumentSizeLimitBytes":8192 }
2.1.x
strategy

(オプション) このコンポーネントが AWS IoT Core とコアデバイス間でシャドウを同期するために使用する戦略。

このオブジェクトには、次の情報が含まれます。

type

(オプション) このコンポーネントが AWS IoT Core とコアデバイス間でシャドウを同期させるために使用する戦略のタイプ。次のオプションから選択します。

  • realTime – シャドウの更新が発生する AWS IoT Core たびに、シャドウを と同期します。

  • periodicdelay設定パラメータ AWS IoT Core で指定した一定の間隔でシャドウを と同期します。

デフォルト: realTime

delay

(オプション) periodic 同期戦略を指定した場合に、このコンポーネントがシャドウを AWS IoT Coreと同期する間隔 (秒単位)。

注記

periodic 同期戦略を指定する場合、このパラメータは必須です。

synchronize

(オプション) シャドウを AWS クラウドと同期する方法を決定する同期設定。

注記

シャドウを AWS クラウドと同期させるには、このプロパティを使用して設定アップデートを作成する必要があります。

このオブジェクトには、次の情報が含まれます。

coreThing

(オプション) 同期するコアデバイスシャドウ。このオブジェクトには、次の情報が含まれます。

classic

(オプション) デフォルトでは、シャドウマネージャーはコアデバイスのクラシックシャドウのローカル状態を AWS クラウドと同期させます。クラシックデバイスシャドウを同期しない場合は、これを false に設定します。

デフォルト: true

namedShadows

(オプション) 同期する名前付きコアデバイスシャドウのリスト。シャドウの正確な名前を指定する必要があります。

警告

この AWS IoT Greengrass サービスは、AWSManagedGreengrassV2Deployment名前付きシャドウを使用して、個々のコアデバイスをターゲットとするデプロイを管理します。この名前付きシャドウは、 AWS IoT Greengrass サービスが使用するために予約されています。この名前付きシャドウを更新または削除しないでください。

shadowDocumentsMap

(オプション) 同期する追加のデバイスシャドウ。この構成パラメータを使用すると、シャドウドキュメントの指定が簡単になります。shadowDocuments オブジェクトの代わりに、このパラメータを使用することをお勧めします。

注記

shadowDocumentsMap オブジェクトを指定する場合は、shadowDocuments オブジェクトを指定しないでください。

各オブジェクトには、次の情報が含まれます:

thingName

のシャドウ設定 thingName このシャドウ設定の 。

classic

(オプション) thingName デバイスのクラシックデバイスシャドウを同期しない場合は、これを false に設定します。

namedShadows

同期する名前付きシャドウのリスト。シャドウの正確な名前を指定する必要があります。

shadowDocuments

(オプション) 同期する追加のデバイスシャドウのリスト。代わりに shadowDocumentsMap パラメータを使用することをお勧めします。

注記

shadowDocuments オブジェクトを指定する場合は、shadowDocumentsMap オブジェクトを指定しないでください。

このリストの各オブジェクトには、次の情報が含まれます。

thingName

シャドウを同期するデバイスのモノの名前。

classic

(オプション) thingName デバイスのクラシックデバイスシャドウを同期しない場合は、これを false に設定します。

デフォルト: true

namedShadows

(オプション) 同期する名前付きデバイスシャドウのリスト。シャドウの正確な名前を指定する必要があります。

rateLimits

(オプション) シャドウサービス要求のレート制限を決定する設定。

このオブジェクトには、次の情報が含まれます。

maxOutboundSyncUpdatesPerSecond

(オプション) デバイスが送信する 1 秒あたりの同期要求の最大数。

デフォルト: 100 要求/秒

maxTotalLocalRequestsRate

(オプション) コアデバイスに送信される 1 秒あたりのローカルIPCリクエストの最大数。

デフォルト: 200 要求/秒

maxLocalRequestsPerSecondPerThing

(オプション) 接続された IoT モノごとに送信される 1 秒あたりのローカルIPCリクエストの最大数。

デフォルト: 1 件につき 20 要求/秒

注記

これらのレート制限パラメータは、ローカルシャドウサービスの 1 秒あたりの最大要求数を定義します。 AWS IoT Device Shadow サービスの 1 秒あたりの最大リクエスト数は、 によって異なります AWS リージョン。詳細については、「」のAWS IoT 「 Device Shadow Service API の制限」を参照してくださいAmazon Web Services 全般のリファレンス

shadowDocumentSizeLimitBytes

(オプション) ローカルシャドウの各JSONステートドキュメントの最大許容サイズ。

この値を増やす場合は、クラウドシャドウの JSON 状態ドキュメントのリソース制限も引き上げる必要があります。詳細については、「」のAWS IoT 「 Device Shadow Service API の制限」を参照してくださいAmazon Web Services 全般のリファレンス

デフォルト: 8,192 バイト

最大: 30720 バイト

例: 設定マージの更新

次の例は、シャドウマネージャーコンポーネントで利用可能なすべての設定パラメータを使用した設定マージ更新のサンプルを示しています。

{ "strategy":{ "type":"periodic", "delay":300 }, "synchronize":{ "shadowDocumentsMap":{ "MyDevice1":{ "classic":false, "namedShadows":[ "MyShadowA", "MyShadowB" ] }, "MyDevice2":{ "classic":true, "namedShadows":[] } }, "direction":"betweenDeviceAndCloud" }, "rateLimits":{ "maxOutboundSyncUpdatesPerSecond":100, "maxTotalLocalRequestsRate":200, "maxLocalRequestsPerSecondPerThing":20 }, "shadowDocumentSizeLimitBytes":8192 }
2.0.x
synchronize

(オプション) シャドウを AWS クラウドと同期する方法を決定する同期設定。

注記

シャドウを AWS クラウドと同期させるには、このプロパティを使用して設定アップデートを作成する必要があります。

このオブジェクトには、次の情報が含まれます。

coreThing

(オプション) 同期するコアデバイスシャドウ。このオブジェクトには、次の情報が含まれます。

classic

(オプション) デフォルトでは、シャドウマネージャーはコアデバイスのクラシックシャドウのローカル状態を AWS クラウドと同期させます。クラシックデバイスシャドウを同期しない場合は、これを false に設定します。

デフォルト: true

namedShadows

(オプション) 同期する名前付きコアデバイスシャドウのリスト。シャドウの正確な名前を指定する必要があります。

警告

この AWS IoT Greengrass サービスは、AWSManagedGreengrassV2Deployment名前付きシャドウを使用して、個々のコアデバイスをターゲットとするデプロイを管理します。この名前付きシャドウは、 AWS IoT Greengrass サービスが使用するために予約されています。この名前付きシャドウを更新または削除しないでください。

shadowDocumentsMap

(オプション) 同期する追加のデバイスシャドウ。この構成パラメータを使用すると、シャドウドキュメントの指定が簡単になります。shadowDocuments オブジェクトの代わりに、このパラメータを使用することをお勧めします。

注記

shadowDocumentsMap オブジェクトを指定する場合は、shadowDocuments オブジェクトを指定しないでください。

各オブジェクトには、次の情報が含まれます:

thingName

のシャドウ設定 thingName このシャドウ設定の 。

classic

(オプション) thingName デバイスのクラシックデバイスシャドウを同期しない場合は、これを false に設定します。

namedShadows

同期する名前付きシャドウのリスト。シャドウの正確な名前を指定する必要があります。

shadowDocuments

(オプション) 同期する追加のデバイスシャドウのリスト。代わりに shadowDocumentsMap パラメータを使用することをお勧めします。

注記

shadowDocuments オブジェクトを指定する場合は、shadowDocumentsMap オブジェクトを指定しないでください。

このリストの各オブジェクトには、次の情報が含まれます。

thingName

シャドウを同期するデバイスのモノの名前。

classic

(オプション) thingName デバイスのクラシックデバイスシャドウを同期しない場合は、これを false に設定します。

デフォルト: true

namedShadows

(オプション) 同期する名前付きデバイスシャドウのリスト。シャドウの正確な名前を指定する必要があります。

rateLimits

(オプション) シャドウサービス要求のレート制限を決定する設定。

このオブジェクトには、次の情報が含まれます。

maxOutboundSyncUpdatesPerSecond

(オプション) デバイスが送信する 1 秒あたりの同期要求の最大数。

デフォルト: 100 要求/秒

maxTotalLocalRequestsRate

(オプション) コアデバイスに送信される 1 秒あたりのローカルIPCリクエストの最大数。

デフォルト: 200 要求/秒

maxLocalRequestsPerSecondPerThing

(オプション) 接続された IoT モノごとに送信される 1 秒あたりのローカルIPCリクエストの最大数。

デフォルト: 1 件につき 20 要求/秒

注記

これらのレート制限パラメータは、ローカルシャドウサービスの 1 秒あたりの最大要求数を定義します。 AWS IoT Device Shadow サービスの 1 秒あたりの最大リクエスト数は、 によって異なります AWS リージョン。詳細については、「」のAWS IoT 「 Device Shadow Service API の制限」を参照してくださいAmazon Web Services 全般のリファレンス

shadowDocumentSizeLimitBytes

(オプション) ローカルシャドウの各JSONステートドキュメントの最大許容サイズ。

この値を増やす場合は、クラウドシャドウの JSON 状態ドキュメントのリソース制限も引き上げる必要があります。詳細については、「」のAWS IoT 「 Device Shadow Service API の制限」を参照してくださいAmazon Web Services 全般のリファレンス

デフォルト: 8,192 バイト

最大: 30720 バイト

例: 設定マージの更新

次の例は、シャドウマネージャーコンポーネントで利用可能なすべての設定パラメータを使用した設定マージ更新のサンプルを示しています。

{ "synchronize": { "coreThing": { "classic": true, "namedShadows": [ "MyCoreShadowA", "MyCoreShadowB" ] }, "shadowDocuments": [ { "thingName": "MyDevice1", "classic": false, "namedShadows": [ "MyShadowA", "MyShadowB" ] }, { "thingName": "MyDevice2", "classic": true, "namedShadows": [] } ] }, "rateLimits": { "maxOutboundSyncUpdatesPerSecond": 100, "maxTotalLocalRequestsRate": 200, "maxLocalRequestsPerSecondPerThing": 20 }, "shadowDocumentSizeLimitBytes": 8192 }

ローカルログファイル

このコンポーネントは、Greengrass nucleus コンポーネントと同じログファイルを使用します。

Linux
/greengrass/v2/logs/greengrass.log
Windows
C:\greengrass\v2\logs\greengrass.log
このコンポーネントのログを確認するには
  • コアデバイスに次のコマンドを実行して、このコンポーネントのログファイルをリアルタイムに確認します。/greengrass/v2 または を置き換える C:\greengrass\v2 AWS IoT Greengrass ルートフォルダへのパス。

    Linux
    sudo tail -f /greengrass/v2/logs/greengrass.log
    Windows (PowerShell)
    Get-Content C:\greengrass\v2\logs\greengrass.log -Tail 10 -Wait

変更ログ

次の表は、コンポーネントの各バージョンにおける変更を示します。

バージョン

変更

2.3.9

Greengrass nucleus バージョン 2.13.0 リリース用にバージョンが更新されました。

2.3.8

バグ修正と機能向上
  • MQTT クライアント接続中にシャドウマネージャーがデッドロック状態を作成する問題を修正しました。

2.3.7

バグ修正と機能向上
  • シャドウマネージャーがシャドウマネージャーの同期中に定期的にNullPointerExceptionエラーを記録する問題を修正しました。

2.3.6

バグ修正と機能向上
  • デバイスがオフラインのときに AWS クラウド 更新によって削除されたシャドウプロパティが、接続が再開された後もローカルシャドウに引き続き存在する問題を修正しました。

2.3.5

Greengrass nucleus バージョン 2.12.0 リリース用にバージョンが更新されました。

2.3.4

バグ修正と機能向上
  • null および空のシャドウ状態ドキュメントのサポートが追加されました。

2.3.3

Greengrass nucleus バージョン 2.11.0 のリリース用にバージョンが更新されました。

2.3.2

バグ修正と機能向上
  • ローカルシャドウデータベースが破損している場合に、シャドウマネージャーが BROKEN 状態になる問題を修正します。

  • Greengrass nucleus バージョン 2.10.0 のリリース用にバージョンが更新されました。

2.3.1

バグ修正と機能向上
  • クラウドシャドウアップデートの同期を妨げる可能性のある状態が修正されています。

  • 名前付きシャドウ同期設定の変更が 1 つの名前付きシャドウにのみ適用される問題が修正されています。

2.3.0

バグ修正と機能向上
  • Greengrass デバイスのプライベートキーがハードウェアセキュリティモジュールに保存されている場合にシャドウが同期されない可能性がある問題を修正しました。

2.2.4

バグ修正と機能向上
  • ローカルのシャドウドキュメントを更新するときに、シャドウのサイズの検証がクラウドと一貫しない問題を修正しました。

  • デプロイが設定ノードに対して RESET を実行する場合に、シャドウマネージャーが設定の更新のリッスンを停止する問題を修正しました。

2.2.3

Greengrass nucleus バージョン 2.9.0 のリリース用にバージョンが更新されました。

2.2.2

Greengrass nucleus バージョン 2.8.0 のリリース用にバージョンが更新されました。

2.2.1

Greengrass nucleus バージョン 2.7.0 のリリース用にバージョンが更新されました。

2.2.0

新機能
  • ローカルの公開/サブスクライブインターフェイスを通じた、ローカルシャドウサービスに関するサポートが追加されています。シャドウMQTTトピックのローカルパブリッシュ/サブスクライブメッセージブローカーと通信して、コアデバイスのシャドウを取得、更新、削除できるようになりました。この機能により、MQTTブリッジを使用してクライアントデバイスとローカルパブリッシュ/サブスクライブインターフェイスの間でシャドウトピックに関するメッセージを中継することで、クライアントデバイスをローカルシャドウサービスに接続できます。

    この機能には、Greengrass nucleus コンポーネントの v2.6.0 以降が必要です。クライアントデバイスをローカルシャドウサービスに接続するには、MQTTブリッジコンポーネント の v2.2.0 以降も使用する必要があります。

  • ローカルシャドウサービスと AWS クラウドの間で、シャドウを同期する方向をカスタマイズするために、direction オプションを設定できるようになりました。このオプションを設定すると、 AWS クラウドへの帯域幅と接続数を低減できます。

2.1.1

バグ修正と機能向上
  • JSON デバイスシャドウ状態ドキュメントの desiredおよび reportedセクションの最大深度が 5 レベルではなく 4 レベルである問題を修正しました。

  • Greengrass nucleus バージョン 2.6.0 のリリース用にバージョンが更新されました。

2.1.0

新機能
  • 定期的なシャドウ同期間隔のサポートが追加されるため、帯域幅の使用量と料金を削減するようにコアデバイスを設定できます。

2.0.6

このバージョンには、バグ修正と機能向上が含まれています。

2.0.5

Greengrass nucleus バージョン 2.5.0 のリリース用にバージョンが更新されました。

2.0.4

バグ修正と機能向上
  • シャドウマネージャーが以前に削除されたシャドウの新しく作成されたバージョンを削除する問題が修正されます。

  • 呼び出し時にシャドウバージョンをインクリメントするように DeleteThingShadowIPCオペレーションを更新します。

2.0.3

Greengrass nucleus バージョン 2.4.0 のリリース用にバージョンが更新されました。

2.0.2

バグ修正と機能向上
  • AWS IoT Coreからシャドウ状態を同期するときにシャドウマネージャーが delta プロパティを認識しない問題を修正しました。

  • シャドウの同期要求が誤ってマージされることがある問題を修正しました。

2.0.1

Greengrass nucleus バージョン 2.3.0 のリリース用にバージョンが更新されました。

2.0.0

当初のバージョン