インストーラ引数 - AWS IoT Greengrass

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

インストーラ引数

AWS IoT Greengrass Core ソフトウェアには、ソフトウェアをセットアップし、Greengrass コアデバイスを実行するのに必要となる AWS リソースをプロビジョニングするインストーラが含まれています。インストーラには、インストールを設定するために指定できる次の引数が含まれます。

-h, --help

(オプション) インストーラのヘルプ情報を表示します。

--version

(オプション) AWS IoT Greengrass Core ソフトウェアのバージョンを表示します。

-Droot

(オプション) AWS IoT Greengrass Core ソフトウェアのルートとして使用するフォルダへのパス。

注記

この引数は JVM プロパティを設定するため、インストーラを実行するときに -jar より前に指定する必要があります。例えば、java -Droot="/greengrass/v2" -jar /path/to/Greengrass.jar と指定します。

デフォルト:

  • Linux: ~/.greengrass

  • Windows: %USERPROFILE%/.greengrass

-ar, --aws-region

AWS IoT Greengrass Core ソフトウェアが、必要な AWS リソースを取得または作成するために使用する AWS リージョン。

-p, --provision

(オプション) このデバイスをAWS IoT モノとして登録し、コアデバイスが必要とする AWS リソースをプロビジョニングすることができます。true を指定すると、AWS IoT Greengrass Core ソフトウェアは、AWS IoT モノ、(オプションの) AWS IoT モノグループ、IAM ロール、および AWS IoT ロールエイリアスをプロビジョニングします。

デフォルト: false

-tn, --thing-name

(オプション) このコアデバイスとして登録する AWS IoT モノの名前。モノの名前が AWS アカウント に存在しない場合、AWS IoT Greengrass Core ソフトウェアが作成します。

注記

モノの名前にコロン (:) 記号を含むことができません。

この引数を適用するには、--provision true を指定する必要があります。

デフォルト: GreengrassV2IotThing_ とランダムな UUID。

-tgn, --thing-group-name

(オプション) このコアデバイスの AWS IoT モノを追加する AWS IoT モノグループの名前。デプロイがこのモノグループをターゲットにしている場合、このコアデバイスは、AWS IoT Greengrass に接続したときにそのデプロイを受け取ります。この名前のモノグループが AWS アカウント に存在しない場合、AWS IoT Greengrass Core ソフトウェアが作成します。

注記

モノグループ名にコロン (:) 記号を含めることはできません。

この引数を適用するには、--provision true を指定する必要があります。

-tpn, --thing-policy-name

この機能は、Greengrass nucleus コンポーネントの v2.4.0 以降に利用できます。

(オプション) このコアデバイスの AWS IoT モノ証明書にアタッチする AWS IoT ポリシーの名前。この名前の AWS IoT ポリシーが AWS アカウント に存在しない場合、AWS IoT Greengrass Core ソフトウェアが作成します。

AWS IoT Greengrass Core ソフトウェアでは、デフォルトで寛容な AWS IoT ポリシーが作成されます。このポリシーの範囲を絞り込むか、ユースケースに応じた権限に制限するカスタムポリシーを作成することができます。詳細については、「AWS IoT Greengrass V2 コアデバイス向けの最低限の AWS IoT ポリシー」を参照してください。

この引数を適用するには、--provision true を指定する必要があります。

デフォルト: GreengrassV2IoTThingPolicy

-trn, --tes-role-name

(オプション) コアデバイスが AWS サービスとやり取りするための AWS 認証情報を取得するために使用する IAM ロールの名前。この名前のロールが AWS アカウント に存在しない場合、AWS IoT Greengrass Core ソフトウェアが GreengrassV2TokenExchangeRoleAccess ポリシーを使ってロールを作成します。このロールは、コンポーネントのアーティファクトをホストする S3 バケットにはアクセスできません。そのため、コンポーネントを作成するときに、アーティファクトの S3 バケットとオブジェクトへのアクセス許可を追加する必要があります。詳細については、「コアデバイスが AWS サービスを操作できるように認証する」を参照してください。

この引数を適用するには、--provision true を指定する必要があります。

デフォルト: GreengrassV2TokenExchangeRole

-tra, --tes-role-alias-name

(オプション) このコアデバイスの AWS 認証情報を提供する IAM ロールを指している AWS IoT ロールエイリアスの名前。この名前のロールエイリアスが AWS アカウント に存在しない場合、AWS IoT Greengrass Core ソフトウェアはそれを作成し、指定されている IAM ロールを指すように設定します。

この引数を適用するには、--provision true を指定する必要があります。

デフォルト: GreengrassV2TokenExchangeRoleAlias

-ss, --setup-system-service

(オプション) AWS IoT Greengrass Core ソフトウェアは、このデバイスの起動時に実行されるシステムサービスとして設定することができます。システムサービス名は greengrass です。詳細については、「Greengrass nucleus をシステムサービスとして設定する」を参照してください。

Linux オペレーティングシステムでこの引数を使用する場合、systemd init システムがデバイス上で利用できる必要があります。

重要

Windows コアデバイスでは、AWS IoT Greengrass Core ソフトウェアをシステムサービスとして設定する必要があります

デフォルト: false

-u, --component-default-user

AWS IoT Greengrass Core ソフトウェアがコンポーネントを実行するために使用するユーザーの名前または ID。例えば、ggc_user と指定することができます。この値は、Windows オペレーティングシステムでインストーラを実行するときに必要となります。

Linux オペレーティングシステムでは、オプションでグループを指定することもできます。ユーザーとグループをコロンで区切って指定します。例: ggc_user:ggc_group。

Linux オペレーティングシステムの場合、次の点についても考慮する必要があります。

  • root として実行する場合、デフォルトのコンポーネントユーザーが設定ファイルで定義されたユーザーになります。設定ファイルでユーザーが定義されていない場合、デフォルトの ggc_user:ggc_group になります。もし ggc_user または ggc_group が存在しない場合は、ソフトウェアが作成します。

  • 非ルートユーザーとして実行すると、AWS IoT Greengrass Core ソフトウェアはそのユーザーとしてコンポーネントを実行します。

  • グループを指定しなかった場合、AWS IoT Greengrass Core ソフトウェアは、システムユーザーのプライマリグループを使用します。

詳細については、「コンポーネントを実行するユーザーを設定する」を参照してください。

-d, --deploy-dev-tools

(オプション) Greengrass CLI コンポーネントをダウンロードして、このコアデバイスにデプロイできます。このツールを使用して、このコアデバイス上でコンポーネントを開発したりデバッグしたりできます。

重要

このコンポーネントは、本番環境ではなく、開発環境でのみで使用することをお勧めします。このコンポーネントは、通常、本番環境では必要とされない情報や操作へのアクセスを提供します。このコンポーネントを必要なコアデバイスにのみデプロイして、最小特権の原則に従います。

この引数を適用するには、--provision true を指定する必要があります。

デフォルト: false

-init, --init-config

(オプション) AWS IoT Greengrass Core ソフトウェアのインストールに使用する設定ファイルへのパス。このオプションを使用すると、特定の nucleus 設定された新しいコアデバイスなどを、設定することができます。

重要

指定した設定ファイルとコアデバイス上の既存の設定ファイルがマージされます。これには、コアデバイス上のコンポーネントとコンポーネント設定が含まれます。設定ファイルには、変更しようとしている設定だけをリストすることをおすすめします。

-tp, --trusted-plugin

(オプション) 信頼されたプラグインとして読み込む JAR ファイルへのパス。このオプションは、フリートプロビジョニングまたはカスタムプロビジョニングでインストールする場合、またはハードウェアセキュリティモジュールでプライベートキーと証明書を使用してインストールする場合など、プロビジョニングプラグインの JAR ファイルを提供するために使用します。

-s, --start

(オプション) AWS IoT Greengrass Core ソフトウェアのインストール後に起動し、オプションでリソースをプロビジョニングすることができます。

デフォルト: true