すべての環境に対する汎用オプション

Availability Zones

アベイラビリティーゾーン (AZ) とは、AWS リージョン内の分離されたロケーションであり、技術施策により他の AZ で発生した障害から隔離されています。同一リージョン内にあるアベイラビリティーゾーン間には、低価格かつ低レイテンシーのネットワーク接続が提供されます。インスタンスの AZ の数を選択します。

Any

Any

Any 1

Any 2

Any 3

Cooldown

クールダウンの期間を指定すると、前のアクティビティの効果が表示される前に、Amazon EC2 Auto Scaling が追加のスケーリングアクティビティを開始するのを防ぐのに役立ちます。クールダウン期間とはスケーリングアクティビティが完了してから別のスケーリングアクティビティが開始されるまでの時間（秒単位）です。

360

0 ～10000

Custom Availability Zones

インスタンスの AZ を定義します。

なし

us-east-1a

us-east-1b

us-east-1c

us-east-1d

us-east-1e

eu-central-1

EnableCapacityRebalancing

Auto Scaling グループのスポットインスタンスに対して容量の再調整機能を有効にするかどうかを指定します。詳細については、Amazon EC2 Auto Scaling ユーザーガイドの「容量の再調整」を参照してください。

このオプションは、aws:ec2:instances 名前空間で EnableSpot が true に設定されており、Auto Scaling グループに少なくとも 1 つのスポットインスタンスがある場合にのみ関連します。

false

true

false

MinSize

Auto Scaling グループで使用するインスタンスの最小数。

1

1 ～10000

MaxSize

Auto Scaling グループで使用するインスタンスの最大数。

4

1 ～10000

DisableIMDSv1

インスタンスメタデータサービスバージョン 1 (IMDSv1) を無効にして IMDSv2 を適用するには、true に設定します。

IMDSv1 と IMDSv2 の両方を有効にするには、false に設定します。

環境のインスタンスのデフォルトは、プラットフォームのオペレーティングシステムに基づいて次のようになります。

詳細については、「インスタンスメタデータサービスの設定」を参照してください。

false – Windows サーバー、Amazon Linux 2 以前をベースとするプラットフォーム

true – Amazon Linux 2023 ベースのプラットフォーム

true

false

EC2KeyName

EC2 インスタンスには、キーペアを使用して安全なログインができます。

なし

IamInstanceProfile

インスタンスプロファイルによって、AWS Identity and Access Management (IAM) ユーザーと AWS サービスは、一時的なセキュリティ認証情報にアクセスして AWS API を呼び出すことができるようになります。インスタンスプロファイルの名前または ARN を指定します。

例:

なし

インスタンスプロファイル名または ARN。

ImageId

独自のカスタム AMI ID を指定して、デフォルトの Amazon Machine Image（AMI）を上書きすることができます。

例：ami-1f316660

なし

InstanceType

Elastic Beanstalk 環境でアプリケーションを実行するために使用されるインスタンスタイプ。

使用可能なインスタンスタイプは、使用されるアベイラビリティーゾーンとリージョンによって異なります。サブネットを選択した場合、そのサブネットを含むアベイラビリティーゾーンによって、使用可能なインスタンスタイプが決まります。

アカウントとリージョンによって異なります。

1 つの EC2 インスタンスタイプ。

アカウント、リージョン、アベイラビリティーゾーンによって異なります。これらの値でフィルタリングされた Amazon EC2 インスタンスタイプのリストを取得できます。詳細については、「Amazon EC2 ユーザーガイド」の「利用可能なインスタンスタイプ」を参照してください。

LaunchTemplateTagPropagationEnabled

true に設定すると、環境にプロビジョニングされた特定のリソースの起動テンプレートへの環境タグの伝播が可能になります。

Elastic Beanstalk は、次のリソースの起動テンプレートにのみタグを伝播できます。

CloudFormation では特定のリソースのテンプレート作成時にのみタグが許可されるため、この制約が存在します。詳細については、「AWS CloudFormation ユーザーガイド」の「TagSpecification」を参照してください。

起動テンプレートの詳細については、以下を参照してください。

このオプションの詳細については、「起動テンプレートへのタグの伝播」を参照してください。

false

true

false

MonitoringInterval

Amazon CloudWatch メトリクスが返される間隔 (分単位)。

5 minute

1 minute

5 minute

SecurityGroups

Auto Scaling グループ内の EC2 インスタンスに割り当てて、インスタンスのファイアウォールルールを定義するために使用する、Amazon EC2 セキュリティグループ ID を一覧表示します。

既存の Amazon EC2 セキュリティグループの ID や、テンプレートで作成した AWS::EC2::SecurityGroup リソースへの参照を含む値をカンマで区切り、1 つの文字列として指定できます。

elasticbeanstalk-default

SSHSourceRestriction

環境に対する SSH アクセスをロックするために使用します。例えば、プライベートサブネット内のインスタンスには、拠点ホストからのみアクセスが可能になるように、EC2 インスタンスに対する SSH アクセスをロックできます。

この文字列は次のような形式になります。

protocol, fromPort, toPort, source_restriction

なし

BlockDeviceMappings

Auto Scaling グループ内のすべてのインスタンスに追加の Amazon EBS ボリュームまたはインスタンスストアボリュームをアタッチします。

インスタンスストアボリュームをマッピングする場合は、ボリューム名にデバイス名をマップする必要があるだけです。ただし、Amazon EBS ボリュームをマッピングする場合は、次のフィールドの一部またはすべてを追加で指定することをお勧めします (各フィールドはコロンで区切る必要があります)。

次の例では、3 つの Amazon EBS ボリューム (1 つ (空) の 100 GB gp2 ボリュームと 1 つのスナップショット、1 つ (空) の 20 GB の io1 ボリュームと 2000 個のプロビジョンド IOPS、およびインスタンスストアボリューム ephemeral0) をアタッチします。インスタンスタイプでサポートされている場合は、複数のインスタンスストアボリュームを添付することができます。

/dev/sdj=:100:true:gp2,/dev/sdh=snap-51eef269,/dev/sdi=:20:true:io1:2000,/dev/sdb=ephemeral0

なし

RootVolumeType

環境の EC2 インスタンスにアタッチされた、Amazon EBS のルートボリューム用のボリュームタイプ (マグネティック、汎用 SSD、プロビジョンド IOPS SSD)。

タイプはプラットフォームによって異なります。

マグネティックストレージの場合、standard。

汎用 SSD の場合、gp2 または gp3。

プロビジョンド IOPS SSD の場合、io1。

RootVolumeSize

Amazon EBS ルートボリュームのストレージ容量を総 GB で表示します。

RootVolumeType をプロビジョンド IOPS SSDに設定した場合は必須。

例えば、"64" と指定します。

マグネティックストレージおよび汎用 SSD の場合はプラットフォームごとに異なります。

プロビジョンド IOPS SSD の場合はありません。

汎用とプロビジョンド IOPS SSD の場合は 10 から 16384 GB。

マグネティックの場合は 8 から 1024 GB。

RootVolumeIOPS

プロビジョンド IOPS SSD ルートボリュームまたは汎用 gp3 SSD ルートボリュームに適用する、1 秒あたりの入力/出力オペレーション (IOPS) 数。

IOPS とボリュームサイズとの比率は最大で 500:1 です。たとえば、3000 IOPS のボリュームのサイズは 6 GiB 以上である必要があります。

なし

io1 プロビジョンド IOPS SSD ボリュームの場合、100 から 20000。

汎用 gp3 SSD ルートボリュームの場合、3000 から 16000。

RootVolumeThroughput

環境の EC2 インスタンスにアタッチされた Amazon EBS ルートボリュームのプロビジョニングに必要なスループット。1 秒あたりのメガバイト数 (MiB/s) で示します。

なし

125 ～1000

StartTime

ワンタイムアクションの場合は、アクションを実行する日時を選択します。繰り返しアクションの場合は、アクションをアクティブ化する日時を選択します。

なし

スケジュールに基づくすべてのスケーリングアクションで一意な ISO-8601 タイムスタンプ。

EndTime

スケジュールに基づくスケーリングアクションの繰り返しを停止する将来の日時 (UTC/GMT タイムゾーン)。[EndTime] を指定しない場合、アクションは Recurrence 式に基づいて繰り返されます。

例：2015-04-28T04:07:2Z

スケジュールに基づくアクションが終了しても、Amazon EC2 Auto Scaling は自動的に以前の設定に戻りません。必要に応じて、元の設定に戻るように、スケジュールに基づいて 2 つ目のアクションを設定します。

なし

スケジュールに基づくすべてのスケーリングアクションで一意な ISO-8601 タイムスタンプ。

MaxSize

アクション実行時に適用される最大インスタンス数。

なし

0 ～10000

MinSize

アクション実行時に適用される最小インスタンス数。

なし

0 ～10000

DesiredCapacity

Auto Scaling グループの初期に必要な容量を設定します。スケジュールに基づくアクションが適用されたら、トリガーは設定に基づき、希望する容量を調整します。

なし

0 ～10000

Recurrence

スケジュールに基づきアクションを実行する頻度。繰り返しを指定していない場合、スケーリングアクションは、StartTime に指定されたタイミングで1 回だけ実行されます。

なし

Cron 式。

Suspend

スケジュールされた繰り返しアクションを一時的に無効にするには true に設定します。

false

true

false

BreachDuration

トリガーが発生する前に、定義された制限 (UpperThreshold と LowerThreshold で指定される値) をメトリクスが超えることができる時間 (分単位)。

5

1 ～600

LowerBreachScaleIncrement

スケーリングアクティビティを実行するときに削除できる Amazon EC2 インスタンス数。

-1

LowerThreshold

測定値がこの数未満になった状態が超過期間だけ続くと、トリガーが発生します。

2000000

0 ～20000000

MeasureName

Auto Scaling をトリガーするために使用されるメトリクス。

NetworkOut

CPUUtilization

NetworkIn

NetworkOut

DiskWriteOps

DiskReadBytes

DiskReadOps

DiskWriteBytes

Latency

RequestCount

HealthyHostCount

UnhealthyHostCount

TargetResponseTime

Period

Amazon CloudWatch でトリガーのメトリクスを測定する頻度を指定します。値は、2 つの連続する期間の分数です。

5

1 ～600

EvaluationPeriods

違反が発生しているかどうかを判断するために使用される連続した評価期間の回数。

1

1 ～600

Statistic

トリガーに使用する Average などの統計データ。

Average

Minimum

Maximum

Sum

Average

Unit

トリガー用の測定単位。Bytes など。

Bytes

Seconds

Percent

Bytes

Bits

Count

Bytes/Second

Bits/Second

Count/Second

None

UpperBreachScaleIncrement

スケーリングアクティビティを実行するときに追加すべき Amazon EC2 インスタンス数を指定します。

1

UpperThreshold

測定値がこの数を超えた状態が超過期間だけ続くと、トリガーが発生します。

6000000

0 ～20000000

MaxBatchSize

ローリング更新の各バッチに含まれるインスタンス数。

Auto Scaling グループ内の最小サイズの 3 分の 1 で次に大きい整数に丸められます。

1 ～10000

MinInstancesInService

他のインスタンスが終了する間、Auto Scaling グループ内で使用中となる必要があるインスタンスの最小数。

Auto Scaling グループの最小サイズ、または Auto Scaling グループの最大サイズよりひとつ下のサイズのいずれか小さい方。

0 ～9999

RollingUpdateEnabled

true の場合、環境のローリング更新が可能になります。ローリング更新は、Elastic Beanstalk ソフトウェアアプリケーションに小規模な更新を頻繁に実行する必要があり、アプリケーションのダウンタイムを発生させないようにする場合に役立ちます。

この値を true に設定すると、自動的に MaxBatchSize、MinInstancesInService、および PauseTime オプションが有効になります。また、これらのオプションのいずれかを設定すると、自動的に RollingUpdateEnabled オプションの値が true に設定されます。このオプションを false に設定すると、ローリング更新が無効になります。

false

true

false

RollingUpdateType

更新には、時間ベースのローリング更新、正常性ベースのローリング更新、イミュータブルな更新の 3 種類があります。

時間ベースのローリング更新では、バッチとバッチの間に PauseTime が適用されます。ヘルスベースのローリング更新では、 新しいインスタンスがヘルスチェックにパスしてはじめて次のバッチに移ります。イミュータブルな更新では、新しい Auto Scaling グループでフルセットのインスタンスが起動されます。

Time

Time

Health

Immutable

PauseTime

Elastic Beanstalk サービスが、インスタンスの 1 つのバッチの更新を完了してから次のバッチに取り掛かるまで待機する時間 (秒、分、または時間単位)。

インスタンスタイプとコンテナに基づいて自動的に計算されます。

PT0S*（0 秒）～PT1H（1 時間）

Timeout

1 つのバッチ内のすべてのインスタンスがヘルスチェックにパスするまでの最大待機時間 (分または時間単位)。これを過ぎると更新がキャンセルされます。

PT30M (30 分)

PT5M* （5 分）～PT1H（1 時間）

*ISO8601 日付形式で、PT#H#M#S のようにする必要があります。それぞれ # は時間数、分数、秒数を示します。

EnableSpot

環境のスポットインスタンスリクエストを有効にします。false の場合、この名前空間の一部のオプションが有効になりません。

false

true

false

InstanceTypes

環境で使用するインスタンスタイプのコンマ区切りのリスト (例: t2.micro,t3.micro)。

スポットインスタンスがアクティブ化していない場合（EnableSpot は false）、リストの最初のインスタンスタイプのみが使用されます。

このオプションのリストの最初のインスタンスタイプは、InstanceType 名前空間の aws:autoscaling:launchconfiguration オプションの値と同じです。後者のオプションは古い形式なため、使用はお勧めしません。両方を指定した場合、InstanceTypes オプションのリストの最初のインスタンスタイプが使用され、InstanceType は無視されます。

使用可能なインスタンスタイプは、使用されるアベイラビリティーゾーンとリージョンによって異なります。サブネットを選択した場合、そのサブネットを含むアベイラビリティーゾーンによって、使用可能なインスタンスタイプが決まります。

環境設定を更新し、InstanceTypes オプションから 1 つ以上のインスタンスタイプを削除すると、Elastic Beanstalk は、削除されたインスタンスタイプで実行されているすべての Amazon EC2 インスタンスを終了します。次に、環境の Auto Scaling グループは、現在指定されているインスタンスタイプを使用して、必要に応じて新しいインスタンスを起動し、必要な容量を完了します。

2 つのインスタンスタイプのリスト。

アカウントとリージョンによって異なります。

1～40 個の EC2 インスタンスタイプ。少なくとも 2 つをレコメンデーションします

アカウント、リージョン、アベイラビリティーゾーンによって異なります。これらの値でフィルタリングされた Amazon EC2 インスタンスタイプのリストを取得できます。詳細については、「Amazon EC2 ユーザーガイド」の「利用可能なインスタンスタイプ」を参照してください。

インスタンスタイプは、すべて同じアーキテクチャに属している必要があります (arm64,x86_64,i386)。

SupportedArchitecturesもこの名前空間の一部です。に任意の値を指定した場合SupportedArchitecturesの場合、入力する値InstanceTypes提供しているアーキテクチャのうちの 1 つのみに属している必要があります。SupportedArchitectures。

SpotFleetOnDemandBase

環境のスケールアップ時にスポットインスタンスを考慮する前に、Auto Scaling グループがプロビジョニングするオンデマンドインスタンスの最小数。

このオプションは、EnableSpot が true の場合にのみ関連します。

0

0 名前空間の MaxSize ～ aws:autoscaling:asg オプション

SpotFleetOnDemandAboveBasePercentage

Auto Scaling グループが SpotOnDemandBase インスタンスを超えてプロビジョニングする追加容量の一部としてのオンデマンドインスタンスの割合。

このオプションは、EnableSpot が true の場合にのみ関連します。

単一インスタンス環境の 0

負荷分散された環境の 70

0 ～100

SpotMaxPrice

スポットインスタンスに対する支払いが許容される、単位時間あたりの上限料金 (USD)。スポットインスタンスの上限価格オプションに関する推奨事項については、「Amazon EC2 ユーザーガイド」の「スポットインスタンスの料金履歴」を参照してください。

このオプションは、EnableSpot が true の場合にのみ関連します。

各インスタンスタイプのオンデマンド価格。この場合のオプションの値は null です。

0.001 ～20.0

null

SupportedArchitectures

環境で使用する Amazon EC2 インスタンスアーキテクチャタイプのコンマ区切りリスト。

Elastic Beanstalk は、次のプロセッサアーキテクチャに基づいてインスタンスタイプをサポートします。

プロセッサアーキテクチャと Amazon EC2 インスタンスタイプの詳細については、「」を参照してください。Amazon EC2 インスタンスタイプ。

なし

arm64

x86_64

i386

VPCId

Amazon VPC の ID。

なし

Subnets

Auto Scaling グループのサブネットまたはサブネットの ID。複数のサブネットがある場合は、各サブネット ID を単一のカンマで区切った文字列 (例: "subnet-11111111,subnet-22222222")として値を指定します。

なし

ELBSubnets

elastic load balancer の単一あるいは複数のサブネットの ID。複数のサブネットがある場合は、各サブネット ID を単一のカンマで区切った文字列 (例: "subnet-11111111,subnet-22222222")として値を指定します。

なし

ELBScheme

Amazon VPC に内部ロードバランサーを作成して、Amazon VPC の外部から Elastic Beanstalk アプリケーションにアクセスできないようにする場合は internal を指定します。public または internal 以外の値を指定すると、Elastic Beanstalk はその値を無視します。

public

public

internal

DBSubnets

データベースサブネットの ID が含まれています。Amazon RDS DB インスタンスをアプリケーションの一部として追加する場合にのみ使用します。複数のサブネットがある場合は、各サブネット ID を単一のカンマで区切った文字列 (例: "subnet-11111111,subnet-22222222")として値を指定します。

なし

AssociatePublicIpAddress

Amazon VPC 内のパブリック IP アドレスを持つインスタンスを起動するかどうかを指定します。パブリック IP アドレスを持つインスタンスは、インターネットと通信するために NAT デバイスを必要としません。ロードバランサーとインスタンスを 1 つのパブリックサブネットに含める場合は、値を true に設定する必要があります。

このオプションは単一インスタンス環境には効果がありません。この環境には Elastic IP アドレスがある単一の Amazon EC2 インスタンスが必ずあります。このオプションは、負荷分散されたスケーラブルな環境に関連します。

なし

true

false

Application Healthcheck URL

ヘルスチェックのリクエストの送信先となるパス。このパスが設定されていない場合、ロードバランサーはポート 80 で TCP 接続を確立し、アプリケーションのヘルスステータスの検証を試みます。/ で始まるパスに設定し、HTTP GET リクエストをそのパスに送信します。プロトコル (HTTP、HTTPS、TCP、SSL) およびパスの前のポートを含めて、HTTPS 接続を確認することも、デフォルトでないポートを使用することもできます。

なし

有効な値を次に示します。

/ (HTTP GET からルートパス)

/health

HTTPS:443/

HTTPS:443/health

環境変数の名前。

キーと値のペアを渡します。

なし

環境変数の値。

StreamLogs

プロキシおよびデプロイログ用に CloudWatch Logs でグループを作成し、環境の各インスタンスからログをストリーミングするかどうかを指定します。

false

true

false

DeleteOnTerminate

環境が終了したときにロググループを削除するかどうかを指定します。false の場合、ログは RetentionInDays 日間保持されます。

false

true

false

RetentionInDays

有効期限が切れるまでログイベントを保持する日数。

7

1、3、5、7、14、30、60、90、120、150、180、365、400、545、731、1827、3653

HealthStreamingEnabled

拡張ヘルスレポートが有効になっている環境で、環境ヘルスの CloudWatch Logs でグループを作成し、Elastic Beanstalk 環境ヘルスデータをアーカイブするかどうかを指定します。拡張ヘルスを有効にする方法については、aws:elasticbeanstalk:healthreporting:system を参照してください。

false

true

false

DeleteOnTerminate

環境が終了したときにロググループを削除するかどうかを指定します。false の場合、ヘルスデータは RetentionInDays 日間保持されます。

false

true

false

RetentionInDays

有効期限が切れる前にアーカイブされたヘルスデータを保持する日数。

7

1、3、5、7、14、30、60、90、120、150、180、365、400、545、731、1827、3653

DeploymentPolicy

Deployment policy を選択しアプリケーションバージョンをデプロイします。

AllAtOnce

AllAtOnce

Rolling

RollingWithAdditionalBatch

Immutable

TrafficSplitting

Timeout

インスタンスでコマンドの実行が完了するまでの待機時間 (秒)。

Elastic Beanstalk は、内部的に 240 秒 (4 分) を Timeout 値に加算します。たとえば、効果的なタイムアウトはデフォルトでは 840 秒 (600+240)、または 14 分です。

600

1 ～3600

BatchSizeType

BatchSize で指定される数値のタイプ。

Percentage

Percentage

Fixed

BatchSize

同時にデプロイを実行する、Auto Scaling グループ内の Amazon EC2 インスタンスの割合または一定数。有効な値は、BatchSizeType の設定によって異なります。

100

1 ～ 100 (Percentage)。

1 (aws:autoscaling:asg::MaxSize (Fixed) に)

IgnoreHealthCheck

ヘルスチェックに合格しなくてもデプロイをキャンセルしません。

true

false

EnvironmentType

SingleInstance に設定すると、ロードバランサーなしの EC2 インスタンスが 1 つ起動されます。

LoadBalanced

SingleInstance

LoadBalanced

ServiceRole

Elastic Beanstalk が環境のリソースを管理するために使用する IAM ロールの名前。ロール名 (オプションでカスタムパスを付けたプレフィックス) またはその ARN を指定します。

例:

なし

IAM ロール名、パス/名前、または ARN

LoadBalancerType

環境のロードバランサーのタイプ。詳細については、「Elastic Beanstalk 環境のロードバランサー」を参照してください。

classic

classic

application

network

LoadBalancerIsShared

環境のロードバランサーが専用か共有かを指定します。このオプションは、Application Load Balancer に対してのみ設定できます。環境が作成されてから後で変更することはできません。

false の場合、環境には独自の専用ロードバランサーがあり、Elastic Beanstalk によって作成および管理されます。の場合、true環境はユーザーが作成し、aws:elbv2:loadbancer 名前空間の SharedLoadBalancer オプションで指定した共有ロードバランサーを使用します。

false

true

false

DeregistrationDelay

登録を解除する前の、アクティブなリクエストが完了するまでの待機時間 (秒単位)。

20

0 ～3600

HealthCheckInterval

Elastic Load Balancing が、アプリケーションの Amazon EC2 インスタンスでヘルスチェックを行う時間間隔 (秒単位)。

標準ロードバランサーまたはアプリケーションロードバランサー: 15

network load balancer: 30

標準ロードバランサーまたはアプリケーションロードバランサー: 5 から 300

network load balancer: 10、30

HealthCheckPath

ヘルスチェックの HTTP リクエストが送信されるパス。

/

ルーティング可能なパス。

HealthCheckTimeout

ヘルスチェック中に、その応答を待つ時間 (秒単位)。

このオプションは、アプリケーションロードバランサーを使用する環境にのみ適用されます。

5

1 ～60

HealthyThresholdCount

Elastic Load Balancing がインスタンスのヘルスステータスを変更するまでの間に、連続して成功したリクエスト数。

標準ロードバランサーまたはアプリケーションロードバランサー: 3

network load balancer: 5

2 ～10

MatcherHTTPCode

インスタンスが正常であることを示す HTTP コードのカンマ区切りのリスト。

このオプションは、ネットワークまたは Application Load Balancer を使用する環境にのみ適用されます。

200

Application Load Balancer: 200 ～ 499

Network Load Balancer: 200 ～ 399

Port

プロセスがリッスンするポート。

80

1 ～65535

Protocol

プロセスで使用するプロトコル。

アプリケーションロードバランサーを使用する場合は、このオプションを HTTP または HTTPS にのみ設定できます。

network load balancerを使用する場合は、このオプションを TCP にのみ設定できます。

標準ロードバランサーまたはアプリケーションロードバランサー: HTTP

network load balancer: TCP

TCP

HTTP

HTTPS

StickinessEnabled

スティッキーセッションを有効にするには、true に設定します。

このオプションは、アプリケーションロードバランサーを使用する環境にのみ適用されます。

'false'

'false'

'true'

StickinessLBCookieDuration

スティッキーセッション Cookie の有効期間 (秒単位)。

このオプションは、アプリケーションロードバランサーを使用する環境にのみ適用されます。

86400 (1 日)

1 ～604800

StickinessType

スティッキーセッション用の Cookie を使用するには、lb_cookie に設定します。

このオプションは、アプリケーションロードバランサーを使用する環境にのみ適用されます。

lb_cookie

lb_cookie

UnhealthyThresholdCount

Elastic Load Balancing がインスタンスのヘルスステータスを変更するまでの間に、連続して失敗したリクエスト数。

5

2 ～10

DeregistrationDelay

登録を解除する前の、アクティブなリクエストが完了するまでの待機時間 (秒単位)。

20

0 ～3600

HealthCheckInterval

Elastic Load Balancing が、アプリケーションの Amazon EC2 インスタンスでヘルスチェックを行う間隔 (秒単位)。

標準ロードバランサーまたはアプリケーションロードバランサー: 15

network load balancer: 30

標準ロードバランサーまたはアプリケーションロードバランサー: 5 から 300

network load balancer: 10、30

HealthCheckPath

ヘルスチェックの HTTP リクエストが送信されるパス。

/

ルーティング可能なパス。

HealthCheckTimeout

ヘルスチェック中に、その応答を待つ時間 (秒単位)。

このオプションは、アプリケーションロードバランサーを使用する環境にのみ適用されます。

5

1 ～60

HealthyThresholdCount

Elastic Load Balancing がインスタンスのヘルスステータスを変更するまでの間に、連続して成功したリクエスト数。

標準ロードバランサーまたはアプリケーションロードバランサー: 3

network load balancer: 5

2 ～10

MatcherHTTPCode

インスタンスが正常であることを示す HTTP コードのリスト (カンマ区切り)。

このオプションは、ネットワークまたは Application Load Balancer を使用する環境にのみ適用されます。

200

Application Load Balancer: 200 ～ 499

Network Load Balancer: 200 ～ 399

Port

プロセスがリッスンするポート。

80

1 ～65535

Protocol

プロセスで使用するプロトコル。

アプリケーションロードバランサーを使用する場合は、このオプションを HTTP または HTTPS にのみ設定できます。

network load balancerを使用する場合は、このオプションを TCP にのみ設定できます。

標準ロードバランサーまたはアプリケーションロードバランサー: HTTP

network load balancer: TCP

TCP

HTTP

HTTPS

StickinessEnabled

スティッキーセッションを有効にするには、true に設定します。

このオプションは、アプリケーションロードバランサーを使用する環境にのみ適用されます。

'false'

'false'

'true'

StickinessLBCookieDuration

スティッキーセッション Cookie の有効期間 (秒単位)。

このオプションは、アプリケーションロードバランサーを使用する環境にのみ適用されます。

86400 (1 日)

1 ～604800

StickinessType

スティッキーセッション用の Cookie を使用するには、lb_cookie に設定します。

このオプションは、アプリケーションロードバランサーを使用する環境にのみ適用されます。

lb_cookie

lb_cookie

UnhealthyThresholdCount

Elastic Load Balancing がインスタンスのヘルスステータスを変更するまでの間に、連続して失敗したリクエスト数。

5

2 ～10

プロキシサーバーのファイルの保存先となるパス。値の先頭は / にします。

例えば、/images を指定して subdomain.eleasticbeanstalk.com/images でファイルを配信します。

ファイルを含むフォルダの名前。

例えば、staticimages を指定してソースバンドルの最上位にある staticimages という名前のフォルダのファイルを配信します。

SystemType

ヘルスレポートシステム (ベーシックまたは拡張)。拡張ヘルスレポートは、サービスロールとバージョン 2 以降のプラットフォームのバージョンを必要とします。

basic

basic

enhanced

EnhancedHealthAuthEnabled

Elastic Beanstalk が、環境インスタンスから Elastic Beanstalk サービスに向けて、拡張ヘルス情報を通信するために使用する内部 API の認可を有効にします。

詳細については、「拡張ヘルスレポートのロール」を参照してください。

true

true

false

HealthCheckSuccessThreshold

インスタンスがヘルスチェックにパスするようにしきい値を下げます。

Ok

Ok

Warning

Degraded

Severe

LogPublicationControl

アプリケーションの Amazon EC2 インスタンスのログファイルを、アプリケーションに関連付けられている Amazon S3 バケットにコピーします。

false

true

false

ManagedActionsEnabled

マネージドプラットフォーム更新を有効にします。

これを true に設定する場合は、PreferredStartTime と UpdateLevel も指定する必要があります。

false

true

false

PreferredStartTime

マネージドアクションのメンテナンス時間を UTC で設定します。

例えば、"Tue:09:00" と指定します。

なし

曜日と時間を

曜日:時間:分

の形式で設定。

ServiceRoleForManagedUpdates

Elastic Beanstalk が環境のマネージドプラットフォーム更新を実行するために使用する IAM ロールの名前。

ServiceRole 名前空間の aws:elasticbeanstalk:environment オプションに指定したものと同じロールを使用することも、アカウントのマネージド更新サービスにリンクされたロールを使用することもできます。後者の場合、マネージド更新サービスにリンクされたロールがまだアカウントになければ、Elastic Beanstalk によって作成されます。

なし

ServiceRole と同じ

または

AWSServiceRoleForElasticBeanstalkManagedUpdates

UpdateLevel

マネージドプラットフォーム更新で適用される最高レベルの更新。プラットフォームのバージョンの表記は、メジャー.マイナー.パッチ です。たとえば、2.0.8 はメジャーバージョン 2、マイナーバージョン 0、パッチ バージョン 8 であることを意味します。

なし

パッチバージョンのみ更新する場合は patch。

マイナーバージョンとパッチバージョンの両方を更新する場合は minor。

InstanceRefreshEnabled

毎週のインスタンス置換を有効にします。

ManagedActionsEnabled を trueに設定する必要があります。

true

false

Automatically Terminate Unhealthy Instances

ヘルスチェックに失敗した場合にインスタンスを終了します。

true

true

false

Notification Endpoint

アプリケーションに影響する重要なイベントについて通知を受け取るエンドポイント。

なし

Notification Protocol

エンドポイントに通知を送信するために使用するプロトコル。

email

http

https

email

email-json

sqs

Notification Topic ARN

サブスクライブするトピックの Amazon リソースネーム (ARN)。

なし

Notification Topic Name

サブスクライブするトピックの名前。

なし

WorkerQueueURL

ワーカー環境枠のデーモンがメッセージを読み込むキューの URL

自動的に生成される

値を指定しない場合、Elastic Beanstalk は自動的にキューを作成します。

HttpPath

HTTP POST メッセージの送信先となるアプリケーションの相対パス。

/

MimeType

HTTP POST リクエストで送信されるメッセージの MIME タイプ。

application/json

application/json

application/x-www-form-urlencoded

application/xml

text/plain

カスタム MIME タイプ。

HttpConnections

Amazon EC2 インスタンス内にあるアプリケーションに同時に接続できる最大数。

50

1 ～100

ConnectTimeout

アプリケーションへの接続が成功するまでの待機時間 (秒単位)

5

1 ～60

InactivityTimeout

アプリケーションへの既存の接続で、応答が返されるまで待機する時間 (秒単位)

299

1 ～36000

VisibilityTimeout

Amazon SQS キューからの着信メッセージが処理のためにロックされる時間の秒数。設定した時間数を経過すると、別のデーモンでの確認用に、メッセージがキューに再度表示されます。

300

0 ～43200

ErrorVisibilityTimeout

明示的なエラーで処理が失敗した後、Elastic Beanstalk が Amazon SQS キューにメッセージを返すまでに経過する時間 (秒単位)。

2 秒

0～43200 秒

RetentionPeriod

メッセージが有効と判断され、アクティブな処理が行われるための時間 (秒単位)。

345600

60 ～1209600

MaxRetries

デッドレターキューにメッセージを移動する前に、Elastic Beanstalk がメッセージを処理するウェブアプリケーションに送信を試行する最大試行回数。

10

1 ～100

NewVersionPercent

Elastic Beanstalk が、デプロイする新しいアプリケーションバージョンを実行している環境インスタンスにシフトする受信クライアントトラフィックの初期の割合。

10

1 ～100

EvaluationTime

初回のデプロイが正常に完了してから、デプロイする新しいアプリケーションバージョンにすべての受信クライアントトラフィックをシフトするまで、Elastic Beanstalk が待機する時間 (分単位)。

5

3 ～600

XRayEnabled

環境のインスタンスで X-Ray デーモンを実行するには、true に設定します。

false

true

false

HealthyThreshold

Elastic Load Balancing がインスタンスのヘルスステータスを変更するまでの間に、連続して成功したリクエスト数。

3

2 ～10

Interval

Elastic Load Balancing が、アプリケーションの Amazon EC2 インスタンスに対し、ヘルスチェックを実行する間隔。

10

5 ～300

Timeout

Elastic Load Balancing が、インスタンスを応答不能と判断するまで、応答を待機する時間 (秒単位)。

5

2 ～60

UnhealthyThreshold

Elastic Load Balancing がインスタンスのヘルスステータスを変更するまでの間に、連続して失敗したリクエスト数。

5

2 ～10

(廃止) Target

バックエンドインスタンス上での、ヘルスチェックの送信先。代わりに Application Healthcheck URL 名前空間の aws:elasticbeanstalk:application を使用します。

TCP:80

PROTOCOL の形式のターゲット: PORT/PATH

CrossZone

ロードバランサーが各ゾーン内のみではなく、すべてのアベイラビリティーゾーン内のすべてのインスタンス間でトラフィックを均等にルーティングするかどうかを設定します。

false

true

false

SecurityGroups

ロードバランサーに、作成した 1 つ以上のセキュリティグループを割り当てます。

なし

1 つまたは複数のセキュリティグループ ID。

新しいセキュリティグループを作成する代わりに、ご使用の環境のロードバランサーに既存のセキュリティグループを割り当てます。この設定を使用するには、この名前空間内の SecurityGroups 設定を変更し、セキュリティグループの IDを含めます。また、自動的に作成されたセキュリティグループがある場合は、その ID を削除します。

ご使用の環境の EC2 インスタンスに対する、ロードバランサーからのトラフィックを許可するために、Elastic Beanstalk は、マネージドセキュリティグループからの着信トラフィックを許可するルールを、インスタンスのセキュリティグループに追加します。

(廃止) LoadBalancerHTTPPort

80

OFF

80

(廃止) LoadBalancerPortProtocol

セキュアでないリスナーで使用するプロトコル。

HTTP

HTTP

TCP

(廃止) LoadBalancerHTTPSPort

OFF

OFF

443

8443

(廃止) LoadBalancerSSLPortProtocol

HTTPS

HTTPS

SSL

(廃止) SSLCertificateId

なし

リスナーが EC2 インスタンスとの通信に使用するプロトコルです。

これは ListenerProtocol と同じインターネットプロトコルレイヤーである必要があります。また、このリスナーとして同じ InstancePort を使用している他のリスナーと同じセキュリティレベルである必要があります。

たとえば、ListenerProtocol が HTTPS (安全な接続を使用したアプリケーションレイヤー) の場合、InstanceProtocol を HTTP (これもアプリケーションレイヤーですが、安全ではない接続を使用します) に設定できます。加えて、InstancePort を 80 に設定する場合、InstanceProtocol が HTTP に設定されているすべてのリスナーで InstancePort を 80 に設定する必要があります。

HTTP が ListenerProtocol の場合、HTTP

TCP が ListenerProtocol の場合、TCP

TCP または SSL。ListenerProtocol が TCP または SSL のとき

true

false

ListenerProtocol

InstancePort

InstanceProtocol

リスナーが EC2 インスタンスとの通信に使用するプロトコルです。

これは ListenerProtocol と同じインターネットプロトコルレイヤーである必要があります。また、このリスナーとして同じ InstancePort を使用している他のリスナーと同じセキュリティレベルである必要があります。

たとえば、ListenerProtocol が HTTPS (安全な接続を使用したアプリケーションレイヤー) の場合、InstanceProtocol を HTTP (これもアプリケーションレイヤーですが、安全ではない接続を使用します) に設定できます。加えて、InstancePort を 80 に設定する場合、InstanceProtocol が HTTP に設定されているすべてのリスナーで InstancePort を 80 に設定する必要があります。

HTTP。ListenerProtocol が HTTP または HTTPS のとき

TCP。ListenerProtocol が TCP または SSL のとき

TCP または SSL。ListenerProtocol が TCP または SSL のとき

PolicyNames

SSLCertificateId

なし

ListenerEnabled

ConnectionDrainingEnabled

ロードバランサーが、処理中のリクエストを完了するために、異常なインスタンスや登録解除されたインスタンスへの既存の接続を維持するかどうかを指定します。

false

true

false

ConnectionDrainingTimeout

ロードバランサーが Connection Draining の実行中にインスタンスへの接続を維持する最大秒数です。この時間を超えると強制的に接続を閉じます。

20

1 ～3600

ConnectionSettingIdleTimeout

接続を介してデータが送信または受信されるまで、ロードバランサーが待機する時間 (秒単位)。この時間が経過してもデータが送受信されなかった場合、ロードバランサーは接続を閉じます。

60

1 ～3600

デフォルトポリシー（AWSEB-ELB-StickinessPolicy）が適用されるリスナーポートのカンマ区切りリストです。

Stickiness Cookie Expiration

各 Cookie の有効時間（秒単位）です。デフォルトポリシー（AWSEB-ELB-StickinessPolicy）を使用します。

0

0 ～1000000

Stickiness Policy

セッション中にユーザーから受信するすべてのリクエストが、同じサーバーインスタンスに送信されるように、ユーザーのセッションを特定のサーバーインスタンスにバインドします。デフォルトポリシー（AWSEB-ELB-StickinessPolicy）を使用します。

false

CookieName

InstancePorts

このポリシーが適用されるインスタンスポートカンマ区切りリストです。

LoadBalancerPorts

このポリシーが適用されるリスナーのカンマ区切りリストです。

ProxyProtocol

ProxyProtocolPolicyType ポリシーで、IP アドレスと TCP メッセージのリクエスト送信元のポートを含めるかどうかを指定します。このポリシーは、TCP/SSL リスナーにのみ関連付けることができます。

PublicKey

バックエンドサーバーを認証するときに使用する PublicKeyPolicyType ポリシーのパブリックキーの内容です。このポリシーは、バックエンドサーバーまたはリスナーに直接適用することはできません。BackendServerAuthenticationPolicyType ポリシーの中に含める必要があります。

PublicKeyPolicyNames

バックエンドサーバーへの認証を管理する BackendServerAuthenticationPolicyType ポリシーのポリシー名 (PublicKeyPolicyType ポリシーから) のカンマ区切りリストです。このポリシーは、HTTPS/SSL を使用しているバックエンドサーバーにのみ関連付けることができます。

SSLProtocols

ロードバランサーで許可される暗号とプロトコルを定義するための、SSLNegotiationPolicyType ポリシーで有効化される、SSL プロトコルのカンマ区切りリスト。このポリシーは、HTTPS/SSL リスナーにのみ関連付けることができます。

SSLReferencePolicy

AWS セキュリティのベストプラクティスに準拠し、ロードバランサーで許可される暗号とプロトコルを定義するために SSLNegotiationPolicyType ポリシーで有効化する事前定義されたセキュリティポリシーの名前です。このポリシーは、HTTPS/SSL リスナーにのみ関連付けることができます。

Stickiness Cookie Expiration

各 Cookie の有効時間（秒単位）です。

0

0 ～1000000

Stickiness Policy

セッション中にユーザーから受信するすべてのリクエストが、同じサーバーインスタンスに送信されるように、ユーザーのセッションを特定のサーバーインスタンスにバインドします。

false

DefaultProcess

ルールが適合しないときにトラフィックを転送するプロセスの名前。

default

プロセス名。

ListenerEnabled

リスナーを無効にするには、false に設定します。ポート 80 でデフォルトリスナーを無効にするには、このオプションを使用できます。

true

true

false

Protocol

処理するトラフィックのプロトコル。

アプリケーションロードバランサー: HTTP

network load balancer: TCP

アプリケーションロードバランサー: HTTP、HTTPS

network load balancer: TCP

Rules

リスナーに適用するルールのリスト

このオプションは、Application Load Balancer を使用する環境にのみ適用されます。

なし

ルール名のリスト (コンマ区切り)。

SSLCertificateArns

リスナーにバインドする SSL 証明書の Amazon リソースネーム (ARN)。

このオプションは、Application Load Balancer を使用する環境にのみ適用されます。

なし

IAM または ACM に保存された証明書の ARN。

SSLPolicy

リスナーに適用するセキュリティポリシーを指定します。

このオプションは、Application Load Balancer を使用する環境にのみ適用されます。

ロードバランサーセキュリティポリシーの名前。

DefaultProcess

ルールが一致しないときにトラフィックを転送するプロセスの名前。

default

プロセス名。

ListenerEnabled

リスナーを無効にするには、false に設定します。ポート 80 でデフォルトリスナーを無効にするには、このオプションを使用できます。

true

true

false

Protocol

処理するトラフィックのプロトコル。

アプリケーションロードバランサー: HTTP

network load balancer: TCP

アプリケーションロードバランサー: HTTP、HTTPS

network load balancer: TCP

Rules

リスナーに適用するルールのリスト

このオプションは、Application Load Balancer を使用する環境にのみ適用されます。

環境が共有 Application Load Balancer を使用し、このオプションをリスナーに指定しない場合、Elastic Beanstalk は自動的に default ルールをポート 80 リスナーに関連付けます。

なし

ルール名のリスト (コンマ区切り)。

SSLCertificateArns

リスナーにバインドする SSL 証明書の Amazon リソースネーム (ARN)。

このオプションは、Application Load Balancer を使用する環境にのみ適用されます。

なし

IAM または ACM に保存された証明書の ARN。

SSLPolicy

リスナーに適用するセキュリティポリシーを指定します。

このオプションは、Application Load Balancer を使用する環境にのみ適用されます。

ロードバランサーセキュリティポリシーの名前。

HostHeaders

一致させるホスト名のリスト。例えば、my.example.com と指定します。

専用ロードバランサー: なし

共有ロードバランサー: 環境の CNAME

それぞれの名前の長さは最大 128 文字です。パターンには、大文字および小文字、数字、ハイフン (–)、および最大 3 つのワイルドカード文字 (* は 0 文字以上に、? はちょうど 1 文字にマッチ) を含めることができます。カンマで区切って、複数の名前をリストできます。Application Load Balancer は、最大 5 つの HostHeader ルールと PathPattern ルールの組み合わせをサポートします。

詳細については、Application Load Balancer のユーザーガイドの「ホストの条件」を参照してください。

PathPatterns

一致させるパスパターン (例えば、/img/*)。

このオプションは、アプリケーションロードバランサーを使用する環境にのみ適用されます。

なし

各パターンの長さは最大 128 文字です。パターンには、大文字および小文字、数字、ハイフン (–)、および最大 3 つのワイルドカード文字 (* は 0 文字以上に、? は ちょうど1 文字にマッチ) を含めることができます。複数のパスパターンをカンマで区切って追加できます。Application Load Balancer は、最大 5 つの HostHeader ルールと PathPattern ルールの組み合わせをサポートします。

詳細については、Application Load Balancer ユーザーガイドの「パスの条件」を参照してください。

Priority

複数のルールが一致する場合の、このルールの優先順位。低い番号が優先されます。2 つのルールに同じ優先順位を設定することはできません。

共有ロードバランサーを使用すると、Elastic Beanstalk では、共有環境全体でルールの優先順位が相対的なものとして扱われ、作成時に絶対的な優先順位にマッピングされます。

1

1 ～1000

Process

このルールがリクエストに適合する場合にトラフィックを転送するプロセスの名前。

default

プロセス名。

AccessLogsS3Bucket

アクセスログが保存される Amazon S3 バケット。このバケットは環境と同じリージョンに置かれ、ロードバランサーからの書き込みアクセスを許可している必要があります。

なし

バケット名。

AccessLogsS3Enabled

アクセスログストレージを有効にします。

false

true

false

AccessLogsS3Prefix

アクセスログ名に前置するプレフィックス。デフォルトでは、ロードバランサーがログをアップロードする先は、指定したバケットの AWSLogs というディレクトリです。別の場所に AWSLogs ディレクトリを配置する場合は、プレフィックスを指定します。

なし

IdleTimeout

クライアントとインスタンスへの接続を閉じる前に、リクエストの完了を待機する時間 (秒単位)。

なし

1 ～3600

ManagedSecurityGroup

新しいセキュリティグループを作成する代わりに、ご使用の環境のロードバランサーに既存のセキュリティグループを割り当てます。この設定を使用するには、この名前空間の SecurityGroups 設定を更新してセキュリティグループの ID を含め、自動的に作成されたセキュリティグループの ID がある場合はそれを削除します。

ロードバランサーから環境の EC2 インスタンスへのトラフィックを許可するために、Elastic Beanstalk は、マネージドセキュリティグループからの着信トラフィックを許可するルールを、インスタンスのセキュリティグループに追加します。

ロードバランサー用に Elastic Beanstalk が作成するセキュリティグループ。

セキュリティグループ ID。

SecurityGroups

ロードバランサーにアタッチするセキュリティグループのリスト。

共有ロードバランサーで、この値を指定しない場合、Elastic Beanstalk は、管理する既存のセキュリティグループがロードバランサーに既にアタッチされているかどうかを確認します。ロードバランサーにアタッチされたセキュリティグループがない場合、Elastic Beanstalk はそれを作成しロードバランサーにアタッチします。Elastic Beanstalk は、ロードバランサーを共有する最後の環境が終了すると、このセキュリティグループを削除します。

ロードバランサーのセキュリティグループは、Amazon EC2 インスタンスのセキュリティグループの入力ルールを設定するために使用されます。

ロードバランサー用に Elastic Beanstalk が作成するセキュリティグループ。

セキュリティグループ ID のカンマ区切りのリスト。

SharedLoadBalancer

共有ロードバランサーの Amazon リソースネーム (ARN)。このオプションは、Application Load Balancer にのみ関連します。aws:elasticbeanstalk:environment 名前空間の LoadBalancerIsShared オプションに true が設定されている場合に必須です。環境の作成後に共有ロードバランサーの ARN を変更することはできません。

有効な値の基準:

例:

arn:aws:elasticloadbalancing:us-east-2:123456789012:loadbalancer/app/FrontEndLB/0dbf78d8ad96abbc

なし

ここに記述されたすべての基準を満たす有効なロードバランサーの ARN。

DBAllocatedStorage

割り当て済みデータベースストレージのサイズ（ギガバイト単位）。

MySQL: 5

Oracle: 10

sqlserver-se: 200

sqlserver-ex: 30

sqlserver-web: 30

MySQL: 5-1024

Oracle: 10-1024

sqlserver: 変更することはできません

DBDeletionPolicy

環境が終了された場合に、DB インスタンスを保持するか、削除するか、そのスナップショットを作成するかを指定します。

このオプションは、HasCoupledDatabase と組み合わせて使用します。この名前空間のオプションでもあります。

Delete

Delete

Retain

Snapshot

DBEngine

このインスタンスに使用するデータベースエンジンの名前。

mysql

mysql

oracle-se1

sqlserver-ex

sqlserver-web

sqlserver-se

postgres

DBEngineVersion

データベースエンジンのバージョン番号。

5.5

DBInstanceClass

データベースインスタンスのタイプ。

db.t2.micro

(Amazon VPC を実行しない環境では db.m1.large)

詳細については、Amazon Relational Database Service ユーザーガイドの「DB インスタンスクラス」を参照してください。

DBPassword

データベースインスタンスのマスターユーザーパスワード。

なし

DBSnapshotIdentifier

リストア元の DB スナップショットの識別子。

なし

DBUser

DB インスタンスのマスターユーザーの名前。

ebroot

HasCoupledDatabase

DB インスタンスが環境にカップリングされているかどうかを指定します。true にした場合、Elastic Beanstalk によって環境にカップリングされた新しい DB インスタンスが作成されます。false にした場合は、Elastic Beanstalk は環境から DB インスタンスのデカップリングを開始します。

このオプションは、DBDeletionPolicy と組み合わせて使用します。この名前空間のオプションでもあります。

false

true

false

MultiAZDatabase

データベースインスタンス Multi-AZ デプロイを作成する必要があるかどうかを指定します。Amazon Relational Database Service (RDS) のマルチ AZ 配置の詳細については、Amazon Relational Database Service ユーザーガイドの、「リージョン、アベイラビリティーゾーン、およびローカルゾーン」を参照してください。

false

true

false