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

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

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

aws:autoscaling:asg

環境の Auto Scaling グループを設定します。詳細については、「Elastic Beanstalk 環境用の Auto Scaling グループ」を参照してください。

名前空間: aws:autoscaling:asg
名前 説明 デフォルト 有効な値

Availability Zones

アベイラビリティーゾーン (AZs) は、他の の障害から分離されるように設計された AWS リージョン内の個別の場所ですAZs。これらは、同じリージョンAZsの他の への安価で低レイテンシーのネットワーク接続を提供します。インスタンスAZsの の数を選択します。

Any

Any

Any 1

Any 2

Any 3

Cooldown

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

360

010000

Custom Availability Zones

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

なし

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 名前空間で EnableSpottrue に設定されており、Auto Scaling グループに少なくとも 1 つのスポットインスタンスがある場合にのみ関連します。

false

true

false

MinSize

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

1

110000

MaxSize

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

4

110000

aws:autoscaling:launchconfiguration

環境に Amazon Elastic Compute Cloud (Amazon EC2) インスタンスを設定します。

環境に使用されるインスタンスは、Amazon EC2起動テンプレートまたは Auto Scaling グループ起動設定リソースを使用して作成されます。以下のオプションは、両方のリソースタイプで使用できます。

詳細については、「Elastic Beanstalk 環境の Amazon EC2インスタンス」を参照してください。Amazon EC2ユーザーガイド の Amazon 章で Amazon EBS Elastic Block Store (EBS) に関する詳細情報を参照することもできます。

名前空間: aws:autoscaling:launchconfiguration
名前 説明 デフォルト 有効な値

DisableIMDSv1

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

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

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

  • Windows サーバーAL2以前 – IMDSv1と IMDSv2 (DisableIMDSv1 デフォルトは false

  • AL2023 – 有効のみ IMDSv2 (DisableIMDSv1 デフォルトは true

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

重要

このオプションを設定すると、Elastic Beanstalk が起動テンプレートを使用して環境を作成したり、起動設定から起動テンプレートに既存の環境を更新したりできます。詳細については、「テンプレートの起動」を参照してください。

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

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

true

false

EC2KeyName

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

注記

Elastic Beanstalk コンソールを使用して環境を作成する場合は、設定ファイルでこのオプションを設定することはできません。このオプションは、このコンソールによって、推奨値に上書きされます。

なし

IamInstanceProfile

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

例:

  • aws-elasticbeanstalk-ec2-role

  • arn:aws:iam::123456789012:instance-profile/aws-elasticbeanstalk-ec2-role

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

なし

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

ImageId

独自のカスタム AMI ID を指定することで、デフォルトの Amazon マシンイメージ (AMI) を上書きできます。

例: ami-1f316660

なし

InstanceType

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

重要

InstanceType オプションはサポートされなくなりました。InstanceTypes 名前空間のより新しく強力な aws:ec2:instances オプションに置き換わりました。この新しいオプションを使用して、環境で 1 つ以上のインスタンスタイプのリストを指定することができます。このリストの最初の値は、ここで説明する aws:autoscaling:launchconfiguration 名前空間に含まれる InstanceType オプションの値に等しくなります。新しいオプションを使用してインスタンスタイプを指定することをお勧めします。指定した場合、新しいオプションは古いオプションよりも優先されます。詳細については、「aws:ec2:instances 名前空間」を参照してください。

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

  • Elastic Beanstalk は Amazon EC2 Mac インスタンスタイプをサポートしていません。

  • Amazon EC2インスタンスファミリーとタイプの詳細については、「Amazon ユーザーガイド」の「インスタンスタイプ」を参照してください。 EC2

  • リージョン間で使用可能なインスタンスタイプの詳細については、「Amazon EC2ユーザーガイド」の「使用可能なインスタンスタイプ」を参照してください。

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

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

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

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

LaunchTemplateTagPropagationEnabled

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

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

  • EBS ボリューム

  • EC2 インスタンス

  • EC2 ネットワークインターフェイス

  • AWS CloudFormation リソースを定義する起動テンプレート

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

重要
  • 既存の環境でこのオプション値を false から true に変更すると、既存のタグに互換性を破る変更が生じる可能性があります。

  • この機能を有効にすると、タグの伝播にEC2交換が必要になり、ダウンタイムが発生する可能性があります。ローリング更新を有効にして設定の変更を一括で適用し、更新プロセス中のダウンタイムを防ぐことができます。詳細については、「設定変更」を参照してください。

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

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

false

true

false

MonitoringInterval

Amazon CloudWatch メトリクスを返す間隔 (分単位)。

5 minute

1 minute

5 minute

SecurityGroups

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

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

elasticbeanstalk-default

SSHSourceRestriction

環境SSHへのアクセスをロックするために使用されます。例えば、EC2インスタンスSSHへのアクセスをロックダウンして、踏み台ホストのみがプライベートサブネット内のインスタンスにアクセスできるようにすることができます。

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

protocol, fromPort, toPort, source_restriction

protocol

進入ルールのプロトコル。

fromPort

開始ポート番号。

toPort

終了ポート番号。

source_restriction

クラスレスドメイン間ルーティング (CIDR) 範囲、またはトラフィックがルーティングする必要があるセキュリティグループ。セキュリティグループ ID を持つセキュリティグループを指定します。

別のアカウントからセキュリティグループを指定するには、セキュリティグループ ID の前に AWS アカウント ID をスラッシュで区切って含めます。もう 1 つのアカウントは同じ AWS リージョンにある必要があります。構文に注意してください。 aws-account-id/security-group-id例: 123456789012/sg-99999999

例:
  • tcp, 22, 22, 54.240.196.185/32

  • tcp, 22, 22, my-security-group-id

  • tcp, 22, 22, 123456789012/their-security-group-id

なし

BlockDeviceMappings

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

重要

このオプションを設定すると、Elastic Beanstalk が起動テンプレートを使用して環境を作成したり、起動設定から起動テンプレートに既存の環境を更新したりできます。詳細については、「テンプレートの起動」を参照してください。

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

  • スナップショット ID

  • サイズ (GB 単位)

  • 合わせて削除 (true または false)

  • ストレージタイプ (gp3gp2standardst1sc1、または io1 の場合のみ)

  • IOPS ( gp3または のみio1

  • スループット (gp3 の場合のみ)

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

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

なし

  • サイズ — 500 ~ 16384 GiB の範囲内でなければなりません

  • スループット — 1 秒あたり 125 ~ 1000 メビバイト (MiB/s) でなければなりません

RootVolumeType

環境のEC2インスタンスにアタッチされたルート Amazon IOPS EBSボリュームに使用するボリュームタイプ (磁気、汎用、SSDまたはプロビジョニングされた SSD)。

重要

このオプションを設定すると、Elastic Beanstalk が起動テンプレートを使用して環境を作成したり、起動設定から起動テンプレートに既存の環境を更新したりできます。詳細については、「テンプレートの起動」を参照してください。

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

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

gp2 またはgp3汎用 SSD。

io1 プロビジョニングされた IOPS の場合SSD。

RootVolumeSize

GB 全体のルート Amazon EBSボリュームのストレージ容量。

をプロビジョニングされた IOPS RootVolumeTypeに設定した場合は必須ですSSD。

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

マグネティックストレージと汎用 では、プラットフォームごとに異なりますSSD。

プロビジョニングされた IOPS にはありませんSSD。

10 から 16384 GB IOPS への汎用とプロビジョニング。 SSD

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

RootVolumeIOPS

プロビジョニングされたIOPSSSDルートボリュームまたは汎用ルートgp3SSDボリュームの 1 秒あたりの必要な入出力オペレーション (IOPS)。

ボリュームサイズIOPSに対する の最大比率は 500 対 1 です。例えば、3000 のボリュームは少なくとも 6 GiB IOPSである必要があります。

なし

100 io1 プロビジョンドIOPSSSDルートボリューム20000の場合は から に。

3000 汎用gp3SSDルートボリューム16000の場合は から に。

RootVolumeThroughput

環境のEC2インスタンスにアタッチされた Amazon EBSルートボリューム用にプロビジョニングする 1 秒あたりのメビバイト (MiB / 秒) の望ましいスループット。

注記

このオプションは、gp3 ストレージタイプにのみ適用されます。

なし

1251000

aws:autoscaling:scheduledaction

環境の Auto Scaling グループのスケジュールされたアクションを設定します。アクションごとに、オプション名、名前空間、各設定の値に加え、resource_name を指定します。例については、「aws:autoscaling:scheduledaction 名前空間」を参照してください。

名前空間: aws:autoscaling:scheduledaction
名前 説明 デフォルト 有効な値

StartTime

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

なし

スケジュールされたすべてのスケーリングアクションで一意の ISO-8601 タイムスタンプ

EndTime

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

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

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

なし

スケジュールされたすべてのスケーリングアクションで一意の ISO-8601 タイムスタンプ

MaxSize

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

なし

010000

MinSize

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

なし

010000

DesiredCapacity

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

なし

010000

Recurrence

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

なし

Cron 式。

Suspend

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

false

true

false

aws:autoscaling:trigger

環境の Auto Scaling グループのスケーリングトリガーを設定します。

注記

この名前空間の 3 つのオプションによって、定義されている上限をトリガーのメトリクスが超えている時間がどれぐらい続くとトリガーが起動されるか決まります。これらのオプションは次のように関連しています。

BreachDuration = Period * EvaluationPeriods

これらのオプションのデフォルト値 (それぞれ 5、5、1) は、この式を満たします。不整合な値を指定すると、引き続き式が満たされるように、Elastic Beanstalk によっていずれかの値が変更される場合があります。

名前空間: aws:autoscaling:trigger
名前 説明 デフォルト 有効な値

BreachDuration

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

5

1600

LowerBreachScaleIncrement

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

-1

LowerThreshold

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

2000000

020000000

MeasureName

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

注記

HealthyHostCountUnhealthyHostCount、および TargetResponseTime は、専用のロードバランサーを使用している環境にのみ適用されます。これらメトリクス値は、共有ロードバランサーで構成された環境では無効です。ロードバランサータイプの詳細については、「Elastic Beanstalk 環境のロードバランサー」を参照してください。

NetworkOut

CPUUtilization

NetworkIn

NetworkOut

DiskWriteOps

DiskReadBytes

DiskReadOps

DiskWriteBytes

Latency

RequestCount

HealthyHostCount

UnhealthyHostCount

TargetResponseTime

Period

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

5

1600

EvaluationPeriods

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

1

1600

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

020000000

aws:autoscaling:updatepolicy:rollingupdate

環境の Auto Scaling グループのローリング更新を設定します。

名前空間: aws:autoscaling:updatepolicy:rollingupdate
名前 説明 デフォルト 有効な値

MaxBatchSize

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

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

110000

MinInstancesInService

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

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

09999

RollingUpdateEnabled

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

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

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

false

true

false

RollingUpdateType

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

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

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

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 各 # は、それぞれ時間、分、および/または秒の数です。

aws:ec2:instances

スポットオプションを含め、環境のインスタンスを設定します。この名前空間は、aws:autoscaling:launchconfigurationaws:autoscaling:asg を補完します。

詳細については、「Elastic Beanstalk 環境用の Auto Scaling グループ」を参照してください。

名前空間: aws:ec2:instances
名前 説明 デフォルト 有効な値

EnableSpot

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

重要

このオプションを設定すると、Elastic Beanstalk が起動テンプレートを使用して環境を作成したり、起動設定から起動テンプレートに既存の環境を更新したりできます。詳細については、「テンプレートの起動」を参照してください。

false

true

false

InstanceTypes

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

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

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

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

  • Elastic Beanstalk は Amazon EC2 Mac インスタンスタイプをサポートしていません。

  • Amazon EC2インスタンスファミリーとタイプの詳細については、「Amazon ユーザーガイド」の「インスタンスタイプ」を参照してください。 EC2

  • リージョン間で使用可能なインスタンスタイプの詳細については、「Amazon EC2ユーザーガイド」の「使用可能なインスタンスタイプ」を参照してください。

注記

一部の古い AWS アカウントでは、スポットインスタンスをサポートしていないデフォルトのインスタンスタイプ (t1.micro など) を Elastic Beanstalk に提供する場合があります。スポットインスタンス・リクエストをアクティベーションして、スポットを support していないインスタンスタイプに関するエラーが表示される場合は、スポットを support するインスタンスタイプを設定してください。スポットインスタンスタイプを選択するには、スポットインスタンスアドバイザーを使用します。

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

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

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

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

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

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

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

SpotFleetOnDemandBase

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

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

0

0 名前空間の MaxSizeaws:autoscaling:asg オプション

SpotFleetOnDemandAboveBasePercentage

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

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

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

負荷分散された環境の 70

0100

SpotMaxPrice

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

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

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

0.00120.0

null

SupportedArchitectures

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

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

  • AWS Graviton 64 ビット Arm アーキテクチャ (arm64)

  • 64 ビットアーキテクチャ (x86_64)

  • 32ビットアーキテクチャ (i386)

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

なし

arm64

x86_64

i386

注記

32 ビットアーキテクチャi386は、大部分の Elastic Beanstalk プラットフォームではサポートされていません。選択することをお勧めします。x86_64またはarm64代わりにアーキテクチャタイプ。

aws:ec2:vpc

カスタム Amazon Virtual Private Cloud (Amazon ) でリソースを起動するように環境を設定しますVPC。この名前空間で設定を行わないと、Elastic Beanstalk はデフォルトの でリソースを起動しますVPC。

名前空間: aws:ec2:vpc
名前 説明 デフォルト 有効な値

VPCId

Amazon の IDVPC。

なし

Subnets

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

なし

ELBSubnets

エラスティックロードバランサーIDsのサブネットの 。複数のサブネットがある場合は、値をサブネットの単一のカンマ区切り文字列 IDs (例: ) として指定します"subnet-11111111,subnet-22222222"

なし

ELBScheme

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

public

public

internal

DBSubnets

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

なし

AssociatePublicIpAddress

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

このオプションは、Elastic IP アドレスを持つ単一の Amazon EC2インスタンスを常に持つ単一インスタンス環境には影響しません。このオプションは、負荷分散されたスケーラブルな環境に関連します。

なし

true

false

aws:elasticbeanstalk:application

アプリケーションのヘルスチェックパスを設定します。詳細については、「ベーシックヘルスレポート」を参照してください。

名前空間: aws:elasticbeanstalk:application
名前 説明 デフォルト 有効な値

アプリケーションヘルスチェック URL

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

注記

Elastic Beanstalk コンソールを使用して環境を作成する場合は、設定ファイルでこのオプションを設定することはできません。このオプションは、このコンソールによって、推奨値に上書きされます。

なし

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

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

/health

HTTPS:443/

HTTPS:443/health

EB CLIおよび Elastic Beanstalk コンソールは、前述のオプションに推奨値を適用します。設定ファイルを使用して同じファイルを設定する場合は、これらの設定を削除する必要があります。詳細については、「推奨値」を参照してください。

aws:elasticbeanstalk:application:environment

アプリケーションの環境プロパティを設定します。

名前空間: aws:elasticbeanstalk:application:environment
名前 説明 デフォルト 有効な値

環境変数の名前。

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

なし

環境変数の値。

詳細については、「環境プロパティとその他のソフトウェアの設定」を参照してください。

aws:elasticbeanstalk:cloudwatch:logs

アプリケーションのインスタンスログストリーミングを設定します。

名前空間: aws:elasticbeanstalk:cloudwatch:logs
名前 説明 デフォルト 有効な値

StreamLogs

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

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

aws:elasticbeanstalk:cloudwatch:logs:health

アプリケーションの環境ヘルスのログストリーミングを設定します。

名前空間: aws:elasticbeanstalk:cloudwatch:logs:health
名前 説明 デフォルト 有効な値

HealthStreamingEnabled

拡張ヘルスレポートが有効になっている環境の場合、環境ヘルスの CloudWatch ログにグループを作成し、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

aws:elasticbeanstalk:command

アプリケーションコードのデプロイポリシーを設定します。詳細については、「デプロイポリシーと設定」を参照してください。

名前空間: aws:elasticbeanstalk:command
名前 説明 デフォルト 有効な値

DeploymentPolicy

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

注記

Elastic Beanstalk コンソールを使用して環境を作成する場合は、設定ファイルでこのオプションを設定することはできません。このオプションは、このコンソールによって、推奨値に上書きされます。

AllAtOnce

AllAtOnce

Rolling

RollingWithAdditionalBatch

Immutable

TrafficSplitting

Timeout

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

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

600

13600

BatchSizeType

で指定されている番号のタイプBatchSize

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

Percentage

Percentage

Fixed

BatchSize

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

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

100

1100 (Percentage)。

1 から aws:autoscaling:asg::MaxSize (Fixed

IgnoreHealthCheck

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

false

true

false

aws:elasticbeanstalk:environment

環境のアーキテクチャとサービスのロールを設定します。

名前空間: aws:elasticbeanstalk:environment
名前 説明 デフォルト 有効な値

EnvironmentType

を に設定SingleInstanceして、ロードバランサーなしで 1 つのEC2インスタンスを起動します。

LoadBalanced

SingleInstance

LoadBalanced

ServiceRole

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

例:

  • aws-elasticbeanstalk-service-role

  • custom-path/custom-role

  • arn:aws:iam::123456789012:role/aws-elasticbeanstalk-service-role

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

なし

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

LoadBalancerType

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

classic

classic

application

network

LoadBalancerIsShared

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

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

false

true

false

aws:elasticbeanstalk:environment:process:default

環境のデフォルトのプロセスを設定します。

名前空間: aws:elasticbeanstalk:environment:process:default
名前 説明 デフォルト 有効な値

DeregistrationDelay

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

20

03600

HealthCheckInterval

Elastic Load Balancing がアプリケーションの Amazon EC2インスタンスの状態をチェックする時間間隔。秒単位。

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

network load balancer: 30

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

network load balancer: 1030

HealthCheckPath

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

/

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

HealthCheckTimeout

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

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

5

160

HealthyThresholdCount

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

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

network load balancer: 5

210

MatcherHTTPCode

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

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

200

Application Load Balancer: 200499

Network Load Balancer: 200399

Port

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

80

165535

Protocol

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

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

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

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

network load balancer: TCP

TCP

HTTP

HTTPS

StickinessEnabled

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

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

'false'

'false'

'true'

StickinessLBCookieDuration

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

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

86400 (1 日)

1604800

StickinessType

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

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

lb_cookie

lb_cookie

UnhealthyThresholdCount

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

5

210

aws:elasticbeanstalk:environment:process:process_name

環境に応じて追加のプロセスを設定します。

名前空間: aws:elasticbeanstalk:environment:process:process_name
名前 説明 デフォルト 有効な値

DeregistrationDelay

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

20

03600

HealthCheckInterval

Elastic Load Balancing がアプリケーションの Amazon EC2インスタンスの状態をチェックする間隔を秒単位で表します。

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

network load balancer: 30

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

network load balancer: 1030

HealthCheckPath

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

/

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

HealthCheckTimeout

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

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

5

160

HealthyThresholdCount

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

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

network load balancer: 5

210

MatcherHTTPCode

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

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

200

Application Load Balancer: 200499

Network Load Balancer: 200399

Port

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

80

165535

Protocol

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

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

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

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

network load balancer: TCP

TCP

HTTP

HTTPS

StickinessEnabled

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

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

'false'

'false'

'true'

StickinessLBCookieDuration

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

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

86400 (1 日)

1604800

StickinessType

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

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

lb_cookie

lb_cookie

UnhealthyThresholdCount

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

5

210

aws:elasticbeanstalk:environment:proxy:staticfiles

静的ファイルを処理するようにプロキシサーバーを設定するには、次の名前空間を使用できます。プロキシサーバーは、指定されたパスのファイルに対するリクエストを受け取ると、アプリケーションにリクエストをルーティングする代わりにファイルを直接処理します。これにより、アプリケーションで処理する必要があるリクエストの数が減ります。

プロキシサーバーで処理されるパスを、静的アセットを含むソースコード内のフォルダにマッピングします。この名前空間で定義される各オプションは、それぞれ異なるパスをマッピングします。

注記

この名前空間は、Amazon Linux 2 以降に基づくプラットフォームブランチに適用されます。環境が Amazon Linux AMI (Amazon Linux 2 より前) ベースのプラットフォームバージョンを使用している場合は、プラットフォーム固有の静的ファイル名前空間プラットフォーム固有のオプションについては、「」を参照してください。

名前空間: aws:elasticbeanstalk:environment:proxy:staticfiles
名前

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

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

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

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

aws:elasticbeanstalk:healthreporting:system

環境に合わせて拡張ヘルスレポートを設定します。

名前空間: aws:elasticbeanstalk:healthreporting:system
名前 説明 デフォルト 有効な値

SystemType

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

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

basic

basic

enhanced

ConfigDocument に発行する環境とインスタンスのメトリクスを説明するJSONドキュメント CloudWatch。 なし

EnhancedHealthAuthEnabled

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

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

注記

このオプションは、拡張ヘルスレポート (SystemTypeenhanced に設定されている場合など) にのみ適用できます。

true

true

false

HealthCheckSuccessThreshold

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

注記

Elastic Beanstalk コンソールを使用して環境を作成する場合は、設定ファイルでこのオプションを設定することはできません。このオプションは、このコンソールによって、推奨値に上書きされます。

Ok

Ok

Warning

Degraded

Severe

aws:elasticbeanstalk:hostmanager

環境内のEC2インスタンスを設定して、ローテーションされたログを Amazon S3 にアップロードします。

名前空間: aws:elasticbeanstalk:hostmanager
名前 説明 デフォルト 有効な値

LogPublicationControl

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

false

true

false

aws:elasticbeanstalk:managedactions

ご使用の環境に合わせて管理対象プラットフォームの更新を設定します。

名前空間: aws:elasticbeanstalk:managedactions
名前 説明 デフォルト 有効な値

ManagedActionsEnabled

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

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

false

true

false

PreferredStartTime

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

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

なし

曜日と時間を

day:hour:minute

の形式で設定。

ServiceRoleForManagedUpdates

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

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

なし

ServiceRole と同じ

または

AWSServiceRoleForElasticBeanstalkManagedUpdates

aws:elasticbeanstalk:managedactions:platformupdate

ご使用の環境に合わせて管理対象プラットフォームの更新を設定します。

名前空間: aws:elasticbeanstalk:managedactions:platformupdate
名前 説明 デフォルト 有効な値

UpdateLevel

マネージドプラットフォーム更新で適用される最高レベルの更新。プラットフォームはバージョニングされている major.minor.patch。 例えば、2.0.8 にはメジャーバージョン 2、マイナーバージョン 0、パッチバージョン 8 があります。

なし

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

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

InstanceRefreshEnabled

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

ManagedActionsEnabledtrueに設定する必要があります。

false

true

false

aws:elasticbeanstalk:monitoring

ヘルスチェックに失敗したEC2インスタンスを終了するように環境を設定します。

名前空間: aws:elasticbeanstalk:monitoring
名前 説明 デフォルト 有効な値

Automatically Terminate Unhealthy Instances

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

注記

このオプションは、レガシー環境でのみサポートされていました。これおよび他のインスタンスベースのメトリクスに到達できるかどうかに基づいてインスタンスの状態を決定します。

Elastic Beanstalk では、アプリケーションの状態に基づいて、自動的にインスタンスを終了させる方法はありません。

true

true

false

aws:elasticbeanstalk:sns:topics

ご使用の環境の通知を設定します。

名前空間: aws:elasticbeanstalk:sns:topics
名前 説明 デフォルト 有効な値

Notification Endpoint

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

注記

Elastic Beanstalk コンソールを使用して環境を作成する場合は、設定ファイルでこのオプションを設定することはできません。このオプションは、このコンソールによって、推奨値に上書きされます。

なし

Notification Protocol

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

email

http

https

email

email-json

sqs

Notification Topic ARN

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

なし

Notification Topic Name

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

なし

aws:elasticbeanstalk:sqsd

ワーカー環境の Amazon SQSキューを設定します。

名前空間: aws:elasticbeanstalk:sqsd
名前 説明 デフォルト 有効な値

WorkerQueueURL

ワーカー環境階層内のデーモンがメッセージを読み取り元のキューURLの 。

注記

値を指定しない場合、Elastic Beanstalk が自動的に作成するキューは標準の Amazon SQSキューです。値を指定するときは、標準キューまたは FIFO Amazon SQSキューURLの を指定できます。FIFO キューを指定すると、定期的なタスクはサポートされないことに注意してください。

自動的に生成される

値を指定しない場合、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インスタンス内にあるアプリケーションへの同時接続の最大数。

注記

Elastic Beanstalk コンソールを使用して環境を作成する場合は、設定ファイルでこのオプションを設定することはできません。このオプションは、このコンソールによって、推奨値に上書きされます。

50

1100

ConnectTimeout

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

5

160

InactivityTimeout

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

メッセージは、ワーカー環境枠でアプリケーションから 200 個 (OK) の応答をデーモンが受信するまで、または RetentionPeriod が有効期限切れになるまで再処理されます。

299

136000

VisibilityTimeout

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

300

043200

ErrorVisibilityTimeout

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

2

043200

RetentionPeriod

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

345600

601209600

MaxRetries

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

10

1100

aws:elasticbeanstalk:trafficsplitting

環境に合わせてトラフィック分割デプロイを設定します。

この名前空間は、aws:elasticbeanstalk:command 名前空間の DeploymentPolicy オプションを TrafficSplitting に設定した場合に適用されます。デプロイのポリシーの詳細については、「デプロイポリシーと設定」を参照してください。

名前空間: aws:elasticbeanstalk:trafficsplitting
名前 説明 デフォルト 有効な値

NewVersionPercent

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

10

1100

EvaluationTime

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

5

3600

aws:elasticbeanstalk:xray

AWS X-Ray デーモンを実行して、X-Ray 統合アプリケーションからトレース情報をリレーします。

名前空間: aws:elasticbeanstalk:xray
名前 説明 デフォルト 有効な値

XRayEnabled

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

false

true

false

aws:elb:healthcheck

Classic Load Balancer のヘルスチェックを設定します。

名前空間: aws:elb:healthcheck
名前 説明 デフォルト 有効な値

HealthyThreshold

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

3

210

Interval

Elastic Load Balancing がアプリケーションの Amazon EC2インスタンスの状態をチェックする間隔。

10

5300

Timeout

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

5

260

UnhealthyThreshold

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

5

210

(廃止) Target

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

TCP:80

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

aws:elb:loadbalancer

環境の Classic Load Balancer を設定します。

この名前空間のオプションのいくつかは、aws:elb:listener名前空間のリスナー固有オプションを優先してサポートされなくなりました。サポート終了したこれらのオプションでは、標準ポートで 2 つの (1 つはセキュアで、もう 1 つはセキュアでない) リスナーのみを構成できます。

名前空間: aws:elb:loadbalancer
名前 説明 デフォルト 有効な値

CrossZone

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

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

false

true

false

SecurityGroups

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

なし

1 つ以上のセキュリティグループ IDs。

ManagedSecurityGroup

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

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

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

(廃止) LoadBalancerHTTPPort

セキュアでないリスナーをリッスンするポート。

80

OFF

80

(廃止) LoadBalancerPortProtocol

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

HTTP

HTTP

TCP

(廃止) LoadBalancerHTTPSPort

セキュアなリスナーをリッスンするポート。

OFF

OFF

443

8443

(廃止) LoadBalancerSSLPortProtocol

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

HTTPS

HTTPS

SSL

(廃止) SSLCertificateId

セキュアリスナーに結合するSSL証明書の Amazon リソースネーム (ARN)。

なし

aws:elb:listener

Classic Load Balancer でデフォルトリスナー (ポート 80) を設定します。

名前空間: aws:elb:listener
名前 説明 デフォルト 有効な値
ListenerProtocol リスナーによって使用されるプロトコルです。 HTTP HTTP TCP
InstancePort このリスナーがEC2インスタンスとの通信に使用するポート。 80 165535
InstanceProtocol

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

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

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

HTTPListenerProtocol の場合、HTTP

TCPListenerProtocol の場合、TCP

HTTP または HTTPSListenerProtocolHTTP または HTTPS のとき

TCP または SSLListenerProtocolTCP または SSL のとき

PolicyNames このリスナーのポートに適用されるポリシー名のカンマ区切りリストです。代わりにaws:elb:policies名前空間 LoadBalancerPorts のオプションを使用することをお勧めします。 なし
ListenerEnabled このリスナーが有効かどうかを指定します。false を指定している場合、リスナーはロードバランサーに含まれません。 true

true

false

aws:elb:listener:listener_port

Classic Load Balancer の追加リスナーを設定します。

名前空間: aws:elb:listener:listener_port
名前 説明 デフォルト 有効な値

ListenerProtocol

リスナーによって使用されるプロトコルです。 HTTP HTTP HTTPS TCP SSL

InstancePort

このリスナーがEC2インスタンスとの通信に使用するポート。 と同じ listener_port. 165535

InstanceProtocol

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

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

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

HTTPListenerProtocolHTTP または HTTPS のとき

TCPListenerProtocolTCP または SSL のとき

HTTP または HTTPSListenerProtocolHTTP または HTTPS のとき

TCP または SSLListenerProtocolTCP または SSL のとき

PolicyNames

このリスナーのポートに適用されるポリシー名のカンマ区切りリストです。代わりにaws:elb:policies名前空間 LoadBalancerPorts のオプションを使用することをお勧めします。 なし

SSLCertificateId

リスナーに結合するSSL証明書の Amazon リソースネーム (ARN)。

なし

ListenerEnabled

このリスナーが有効かどうかを指定します。false を指定している場合、リスナーはロードバランサーに含まれません。 他のオプションが設定されている場合は true です。それ以外の場合は false true false

aws:elb:policies

Classic Load Balancer のデフォルトの維持およびグローバルロードバランサーポリシーを変更します。

名前空間: aws:elb:policies
名前 説明 デフォルト 有効な値

ConnectionDrainingEnabled

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

注記

Elastic Beanstalk コンソールまたは EB を使用して環境CLIを作成する場合、設定ファイル でこのオプションを設定することはできません。コンソールと EB は、このオプションを推奨値 でCLI上書きします。

false

true

false

ConnectionDrainingTimeout

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

注記

Elastic Beanstalk コンソールを使用して環境を作成する場合は、設定ファイルでこのオプションを設定することはできません。このオプションは、このコンソールによって、推奨値に上書きされます。

20

13600

ConnectionSettingIdleTimeout

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

60

13600

LoadBalancerPorts

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

なし :allを使用してすべてのリスナーポートを指定できます。

Stickiness Cookie Expiration

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

0

01000000

Stickiness Policy

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

false

true false

aws:elb:policies:policy_name

Classic Load Balancer の追加のロードバランーサポリシーを作成します。

名前空間: aws:elb:policies:policy_name
名前 説明 デフォルト 有効な値

CookieName

アプリケーションによって生成され、AppCookieStickinessPolicyType ポリシーのセッション存続期間を管理する Cookie の名前です。このポリシーは、HTTP/HTTPS リスナーにのみ関連付けることができます。 なし

InstancePorts

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

なし ポートのリスト、または :all

LoadBalancerPorts

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

なし ポートのリスト、または :all

ProxyProtocol

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

なし true false

PublicKey

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

なし

PublicKeyPolicyNames

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

なし

SSLProtocols

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

なし

SSLReferencePolicy

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

なし

Stickiness Cookie Expiration

各 Cookie の有効時間(秒単位)です。

0

01000000

Stickiness Policy

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

false

true false

aws:elbv2:listener:default

Application Load Balancer または Network Load Balancer のデフォルトのリスナー (ポート 80) を設定します。

この名前空間は、共有ロードバランサーを使用する環境には適用されません。共有ロードバランサーにはデフォルトのリスナーがありません。

名前空間: aws:elbv2:listener:default
名前 説明 デフォルト 有効な値

DefaultProcess

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

default

プロセス名。

ListenerEnabled

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

true

true

false

Protocol

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

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

network load balancer: TCP

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

network load balancer: TCP

Rules

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

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

なし

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

SSLCertificateArns

リスナーに結合するSSL証明書の Amazon リソースネーム (ARN)。

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

なし

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

SSLPolicy

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

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

なし (ELBデフォルト)

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

aws:elbv2:listener:listener_port

Application Load Balancer または Network Load Balancer の追加リスナーを設定します。

注記

共有 Application Load Balancer の場合は、Rule オプションのみを指定できます。その他のオプションは、共有ロードバランサーには適用されません。

名前空間: aws:elbv2:listener:listener_port
名前 説明 デフォルト 有効な値

DefaultProcess

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

default

プロセス名。

ListenerEnabled

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

true

true

false

Protocol

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

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

network load balancer: TCP

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

network load balancer: TCP

Rules

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

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

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

なし

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

SSLCertificateArns

リスナーに結合するSSL証明書の Amazon リソースネーム (ARN)。

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

なし

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

SSLPolicy

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

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

なし (ELBデフォルト)

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

aws:elbv2:listenerrule:rule_name

Application Load Balancer 用のリスナールールを定義します。リクエストがルールのホスト名あるいはパスと一致する場合、ロードバランサーはこのリクエストを指定されたプロセスに転送します。ルールを使用するには、Rules 名前空間の aws:elbv2:listener:listener_port オプションでそのルールをリスナーに追加します。

注記

この名前空間は、network load balancerを使用する環境には適用されません。

名前空間: aws:elbv2:listenerrule:rule_name
名前 説明 デフォルト 有効な値

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

11000

Process

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

default

プロセス名。

aws:elbv2:loadbalancer

Application Load Balancer を設定します。

共有ロードバランサーの場合、SharedLoadBalancer および SecurityGroups オプションのみが有効です。

注記

この名前空間は、Network Load Balancer を使用する環境には適用されません。

名前空間: aws:elbv2:loadbalancer
名前 説明 デフォルト 有効な値

AccessLogsS3Bucket

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

なし

バケット名。

AccessLogsS3Enabled

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

false

true

false

AccessLogsS3Prefix

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

なし

IdleTimeout

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

なし

13600

ManagedSecurityGroup

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

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

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

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

SecurityGroups

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

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

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

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

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

SharedLoadBalancer

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

有効な値の基準:

  • 環境が存在する AWS リージョンで有効なアクティブなロードバランサーである必要があります。

  • 環境と同じ Amazon Virtual Private Cloud (Amazon VPC) にある必要があります。

  • 別の環境の専用ロードバランサーとして Elastic Beanstalk によって作成されたロードバランサーにはできません。これらの専用ロードバランサーは、プレフィックス awseb- で識別できます。

例:

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

なし

ARN ここで説明するすべての基準を満たす有効なロードバランサーの 。

aws:rds:dbinstance

アタッチされた Amazon RDS DB インスタンスを設定します。

名前空間: aws:rds:dbinstance
名前 説明 デフォルト 有効な値

DBAllocatedStorage

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

マイ SQL: 5

Oracle: 10

sqlserver-se: 200

sqlserver-ex: 30

sqlserver-web: 30

マイ SQL: 5-1024

Oracle: 10-1024

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

DBDeletionPolicy

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

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

警告

DB インスタンスを削除した場合、そのデータは復元できません。

Delete

Delete

Retain

Snapshot

DBEngine

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

mysql

mysql

oracle-se1

sqlserver-ex

sqlserver-web

sqlserver-se

postgres

DBEngineVersion

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

5.5

DBInstanceClass

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

db.t2.micro

db.m1.largeAmazon で実行されていない環境の場合VPC)

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

DBPassword

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

なし

DBSnapshotIdentifier

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

なし

DBUser

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

ebroot

HasCoupledDatabase

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

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

注記

注: 以前のデータベースをデカップリングした後、この値を true に戻した場合、Elastic Beanstalk は以前のデータベースオプション設定を使用して新しいデータベースを作成します。ただし、環境のセキュリティを維持するために、既存の DBUser および DBPassword 設定は保持されません。DBUser および DBPassword を再度指定する必要があります。

false

true

false

MultiAZDatabase

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

false

true

false