コンポーネントライフサイクルの操作

コンポーネントライフサイクルの IPC サービスを使用して、次を行います。

最小 SDK バージョン

次の表に、AWS IoT Device SDK の最小バージョンを示します。コンポーネントのライフサイクルを操作する際は、これを使用する必要があります。

認可

カスタムコンポーネントから他のコンポーネントを一時停止または再開するには、コンポーネントが他のコンポーネントを管理できるようにする承認ポリシーを定義する必要があります。承認ポリシーの定義については、「コンポーネントに IPC オペレーションの実行を許可する」を参照してください。

コンポーネントライフサイクル管理の承認ポリシーには、次のプロパティがあります。

IPC サービス識別子: aws.greengrass.ipc.lifecycle

承認ポリシーの例

次の承認ポリシーの例を参照して、コンポーネントの承認ポリシーの設定に役立てることができます。

{
  "accessControl": {
    "aws.greengrass.ipc.lifecycle": {
      "com.example.MyLocalLifecycleComponent:lifecycle:1": {
        "policyDescription": "Allows access to pause/resume all components.",
        "operations": [
          "aws.greengrass#PauseComponent",
          "aws.greengrass#ResumeComponent"
        ],
        "resources": [
          "*"
        ]
      }
    }
  }
}

UpdateState

コアデバイスのコンポーネントの状態を更新します。

リクエスト

このオペレーションのリクエストには以下のパラメータがあります。

レスポンス

このオペレーションはレスポンスで一切の情報を提供しません。

SubscribeToComponentUpdates

AWS IoT Greengrass Core ソフトウェアがコンポーネントを更新する前に通知を受け取るようにサブスクライブします。通知では、更新の一部として nucleus を再起動するかどうかを指定します。

nucleus は、デプロイのコンポーネント更新ポリシーがコンポーネントに通知するように指定されている場合のみ、更新通知を送信します。デフォルトの動作では、コンポーネントに通知を行います。詳細については、デプロイの作成 および CreateDeployment オペレーションを呼び出すときに提供できる DeploymentComponentUpdatePolicy オブジェクトを参照してください。

このオペレーションはサブスクリプションオペレーションで、イベントメッセージのストリームをサブスクライブするというものです。このオペレーションを使用するには、イベントメッセージ、エラー、およびストリームクロージャを処理する関数を使用して、ストリームレスポンスハンドラーを定義します。(詳細については、IPC イベントストリームへのサブスクライブ を参照してください)。

イベントメッセージの種類: ComponentUpdatePolicyEvents

リクエスト

このオペレーションのリクエストはパラメータを持ちません。

レスポンス

このオペレーションのレスポンスには以下の情報が含まれます。

DeferComponentUpdate

SubscribeToComponentUpdates で検出したコンポーネントの更新を承認または延期します。コンポーネントが更新を進める準備ができているかどうか、nucleus が再度チェックするまで待機する時間を指定します。このオペレーションを使用して、コンポーネントが更新の準備ができていることを nucleus に通知することもできます。

コンポーネントがコンポーネント更新通知に応答しない場合、nucleus はデプロイのコンポーネント更新ポリシーで指定した時間だけ待機します。これがタイムアウトした後、nucleus はデプロイを続行します。デフォルトのコンポーネント更新のタイムアウトは 60 秒です。詳細については、デプロイの作成 および CreateDeployment オペレーションを呼び出すときに提供できる DeploymentComponentUpdatePolicy オブジェクトを参照してください。

リクエスト

このオペレーションのリクエストには以下のパラメータがあります。

レスポンス

このオペレーションはレスポンスで一切の情報を提供しません。

PauseComponent

この機能は、Greengrass nucleus コンポーネントの v2.4.0 以降に利用できます。AWS IoT Greengrass は、現在 Windows コアデバイスにこの機能をサポートしていません。

コアデバイスのコンポーネントのプロセスを一時停止します。コンポーネントを再開するには、ResumeComponent オペレーションを使用します。

一時停止できるのはジェネリックコンポーネントのみです。他の種類のコンポーネントを一時停止しようとすると、オペレーションは InvalidRequestError をスローします。

このオペレーションは、コンポーネントの依存関係や、一時停止するコンポーネントに依存するコンポーネントに対しては、一時停止を行いません。別のコンポーネントの依存関係であるコンポーネントを一時停止するときは、この動作を検討してください。依存するコンポーネントは、依存関係が一時停止されたときに問題が発生する可能性があるためです。

デプロイ経由などで一時停止したコンポーネントを再起動またはシャットダウンすると、Greengrass nucleus はコンポーネントを再開し、シャットダウンライフサイクルを実行します。コンポーネントの再起動についての詳細は、「RestartComponent」を参照してください。

最小 SDK バージョン

以下の表に AWS IoT Device SDK の最小バージョンを示します。コンポーネントを一時停止および再開する際は、これを使用する必要があります。

リクエスト

このオペレーションのリクエストには以下のパラメータがあります。

レスポンス

このオペレーションはレスポンスで一切の情報を提供しません。

ResumeComponent

この機能は、Greengrass nucleus コンポーネントの v2.4.0 以降に利用できます。AWS IoT Greengrass は、現在 Windows コアデバイスにこの機能をサポートしていません。

コアデバイスのコンポーネントのプロセスを再開します。コンポーネントを一時停止するには、PauseComponent オペレーションを使用します。

再開できるのは一時停止しているコンポーネントのみです。一時停止していないコンポーネントを再開しようとすると、このオペレーションは InvalidRequestError をスローします。

最小 SDK バージョン

以下の表に AWS IoT Device SDK の最小バージョンを示します。コンポーネントを一時停止および再開する際は、これを使用する必要があります。

リクエスト

このオペレーションのリクエストには以下のパラメータがあります。

レスポンス

このオペレーションはレスポンスで一切の情報を提供しません。