MQTT 5 ブローカー (EMQX)

(オプション) 使用する EMQX MQTT ブローカー設定。このコンポーネントで EMQX 設定オプションを設定できます。

EMQX ブローカーを使用する場合、Greengrass ではデフォルト設定が使用されます。このフィールドを使用して変更しない限り、この設定が使用されます。

以下の設定を変更すると、EMQX Broker コンポーネントが再起動します。他の設定変更は、コンポーネントを再起動せずに適用されます。

{
  "authorization": {
    "no_match": "deny",
    "sources": []
  },
  "node": {
    "cookie": "<placeholder>"
  }, 
  "listeners": {
     "ssl": {
       "default": {
         "ssl_options": {
           "keyfile": "{work:path}\\data\\key.pem",
           "certfile": "{work:path}\\data\\cert.pem",
           "cacertfile": null,
           "verify": "verify_peer",
           "versions": ["tlsv1.3", "tlsv1.2"],
           "fail_if_no_peer_cert": true
         }
       }
     },
     "tcp": {
       "default": {
         "enabled": false
       }
     },
     "ws": {
       "default": {
         "enabled": false
       }
     },
     "wss": {
       "default": {
         "enabled": false
       }
     }
  },
  "plugins": {
    "states": [{"name_vsn": "gg-1.0.0", "enable": true}],
    "install_dir": "plugins"
  }
}

(オプション) ブローカーの認可プロバイダーを設定します。次のいずれかの値を指定できます。

(オプション) Linux コアデバイスでは、ルート権限または管理者権限なしで EMQX MQTT ブローカーを実行するように指定できます。このオプションを false に設定した場合、このコンポーネントを実行するシステムユーザーは、docker グループのメンバーである必要があります。

デフォルト: true

(オプション) EMQX MQTT ブローカーが起動する最大時間 (秒)。このタイムアウトを超えている場合、コンポーネントの状態が BROKEN に変わります。

デフォルト: 90

(オプション) Greengrass nucleus がプロセス間通信 (IPC) リクエストに応答するまでコンポーネントが待機する最大時間 (秒)。このコンポーネントがクライアントデバイスが認証されているかどうかを確認するときにタイムアウトエラーを報告する場合は、この数値を増やします。

デフォルト: 5

（オプション) AWS 共通ランタイム (CRT) ライブラリのログレベル。

デフォルトは EMQX MQTT ブローカーのログレベル (emqx の log.level)。

(オプション) EMQX MQTT ブローカーを再起動するには、このオプションを設定します。この設定値が変更されると、このコンポーネントは MQTT ブローカーを再起動します。このオプションを使用して、クライアントデバイスを強制的に切断できます。

(オプション) Docker コマンドラインにパラメータを追加するには、Linux オペレーティングシステムでのみこのオプションを設定します。例えば、追加のポートをマッピングするには、-p Docker パラメータを使用します。

"-p 1883:1883"

(オプション) 使用する EMQX MQTT ブローカー設定。このコンポーネントで EMQX 設定オプションのサブセットを設定できます。

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

(オプション) Linux コアデバイスでは、ルート権限または管理者権限なしで EMQX MQTT ブローカーを実行するように指定できます。このオプションを false に設定した場合、このコンポーネントを実行するシステムユーザーは、docker グループのメンバーである必要があります。

デフォルト: true

(オプション) EMQX MQTT ブローカーが起動する最大時間 (秒)。このタイムアウトを超えている場合、コンポーネントの状態が BROKEN に変わります。

デフォルト: 90

(オプション) Greengrass nucleus がプロセス間通信 (IPC) リクエストに応答するまでコンポーネントが待機する最大時間 (秒)。このコンポーネントがクライアントデバイスが認証されているかどうかを確認するときにタイムアウトエラーを報告する場合は、この数値を増やします。

デフォルト: 5

（オプション) AWS 共通ランタイム (CRT) ライブラリのログレベル。

デフォルトは EMQX MQTT ブローカーのログレベル (emqx の log.level)。

(オプション) EMQX MQTT ブローカーを再起動するには、このオプションを設定します。この設定値が変更されると、このコンポーネントは MQTT ブローカーを再起動します。このオプションを使用して、クライアントデバイスを強制的に切断できます。

(オプション) Docker コマンドラインにパラメータを追加するには、Linux オペレーティングシステムでのみこのオプションを設定します。例えば、追加のポートをマッピングするには、-p Docker パラメータを使用します。

"-p 1883:1883"

(オプション) 指定した EMQX 設定ファイルのデフォルトに追加したり、デフォルトをオーバーライドしたりするには、このオプションを設定します。設定ファイルとその形式については、EMQX 4.0 ドキュメントの「Configuration」(設定) を参照してください。指定した値は、設定ファイルに付加されます。

次の例では、etc/emqx.conf ファイルを更新します。

"mergeConfigurationFiles": {
    "etc/emqx.conf": "broker.sys_interval=30s\nbroker.sys_heartbeat=10s"
},

EMQX によってサポートされている設定ファイルに加えて、Greengrass は、etc/plugins/aws_greengrass_emqx_auth.conf と呼ばれる EMQX 用の Greengrass 認証プラグインを設定するファイルをサポートしています。サポートされているオプションは auth_mode と use_greengrass_managed_certificates の 2 つです。別の認証プロバイダーを使用するには、auth_mode オプションを次のいずれかに設定します。

use_greengrass_managed_certificates が true の場合、このオプションは Greengrass がブローカー TLS 証明書を管理することを示します。false の場合は、別のソースを通じて証明書を提供していることを示しています。

次の例では、etc/plugins/aws_greengrass_emqx_auth.conf 設定ファイルのデフォルトを更新します。

"mergeConfigurationFiles": {
    "etc/plugins/aws_greengrass_emqx_auth.conf": "auth_mode=enabled\n use_greengrass_managed_certificates=true\n"
  },

(オプション) 指定した EMQX 設定ファイルを置き換えるには、このオプションを設定します。指定した値は、既存の設定ファイル全体を置き換えます。このセクションでは etc/emqx.conf ファイルを指定できません。mergeConfigurationFile を使用して etc/emqx.conf を変更する必要があります。