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

# Elastic Beanstalk API での拡張ヘルスレポートの使用
<a name="health-enhanced-api"></a>

 AWS Elastic Beanstalk 拡張ヘルスレポートにはロールとソリューションスタックの要件があるため、拡張ヘルスレポートをリリースする前に使用したスクリプトとコードを更新する必要があります。下位互換性を維持するため、拡張ヘルスレポートは、Elastic Beanstalk API を使用して環境を作成するとき、デフォルトでは有効になりません。

環境のサービスロール、インスタンスプロファイル、および Amazon CloudWatch 設定オプションを設定することによって、拡張ヘルスレポートを設定します。これは、`.ebextensions` フォルダーで設定オプションを設定する、保存されている設定を使用する、または `create-environment` 呼び出しの `option-settings` パラメータで直接設定オプションを設定することによって行うことができます。

API、SDKs、または AWS コマンドラインインターフェイス (CLI) を使用して拡張ヘルスをサポートする環境を作成するには、以下を実行する必要があります。
+ 適切な[アクセス権限](concepts-roles.md)を含むサービスロールとインスタンスプロファイルを作成する
+ 新しい[プラットフォームのバージョン](concepts.platforms.md)で新しい環境を作成する
+ ヘルスシステムのタイプ、インスタンスプロファイル、サービスロールの[設定オプション](command-options.md)を設定する

`aws:elasticbeanstalk:healthreporting:system`、`aws:autoscaling:launchconfiguration`、および `aws:elasticbeanstalk:environment` の 3 つの名前空間で以下の設定オプションを使用して、拡張ヘルスレポートの環境を設定します。

## 拡張ヘルスの設定オプション
<a name="health-enhanced-api-options"></a>

**SystemType**

名前空間: `aws:elasticbeanstalk:healthreporting:system`

拡張ヘルスレポートを有効にするには、「**enhanced**」に設定します。

**IamInstanceProfile**

名前空間: `aws:autoscaling:launchconfiguration`

Elastic Beanstalk 用に設定されたインスタンスプロファイルの名前に設定します。

**ServiceRole**

名前空間: `aws:elasticbeanstalk:environment`

Elastic Beanstalk 用に設定されたサービスロールの名前に設定します。

**ConfigDocument** (オプション)

名前空間: `aws:elasticbeanstalk:healthreporting:system`

インスタンスと CloudWatch にパブリッシュする環境メトリクスを定義する JSON ドキュメント。次に例を示します。

```
{
  "CloudWatchMetrics":
    {
    "Environment":
      {
      "ApplicationLatencyP99.9":60,
      "InstancesSevere":60
      }
    "Instance":
      {
      "ApplicationLatencyP85":60,
      "CPUUser": 60
      }
    }
  "Version":1
}
```

**注記**  
設定ドキュメントでは、Elastic Beanstalk への提供方法に応じて、引用符のエスケープなどの特別なフォーマットが必要になることがあります。例については、「[カスタムメトリクス設定ドキュメントの提供](health-enhanced-cloudwatch.md#health-enhanced-cloudwatch-configdocument)」を参照してください。