メニュー
AWS Elastic Beanstalk
開発者ガイド (API Version 2010-12-01)

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

aws:autoscaling:asg

環境の Auto Scaling グループを設定します。

名前空間: aws:autoscaling:asg

名前 説明 デフォルト 有効な値

アベイラビリティーゾーン

アベイラビリティーゾーン(AZ)は、他のゾ-ンからの影響を受けないようにリージョン内で各々独立しています。利用は安価で、同一リージョン内であれば AZ 間でのネットワーク接続待ち時間は少なくなります。インスタンスの AZ の数を選択します。

すべて 1

すべて 1

すべて 2

Cooldown

クールダウンの期間を指定すると、前のアクティビティの効果が表示される前に、Auto Scaling によって追加のスケーリングアクティビティが実行されることを防ぐことができます。

360

010000

Custom Availability Zones

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

なし

us-east-1a

us-east-1b

us-east-1c

us-east-1d

us-east-1e

eu-central-1

MinSize

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

1

110000

MaxSize

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

4

110000

aws:autoscaling:launchconfiguration

環境内にある EC2 インスタンスを設定する。

名前空間: aws:autoscaling:launchconfiguration

名前 説明 デフォルト 有効な値

EC2KeyName

キーペアを使用すると、 EC2 インスタンスに安全にログインすることができます。

なし

IamInstanceProfile

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

例: ElasticBeanstalkProfile

例: arn:aws:iam::123456789012:instance-profile/ElasticBeanstalkProfile

なし

ImageId

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

例: ami-cbab67a2

なし

InstanceType

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

使用できるインスタンスタイプは、プラットフォーム、ソリューションスタック(設定)、リージョンによって異なります。選択したソリューションスタックで使用できるインスタンスタイプを取得するには、DescribeConfigurationOptions アクション(API の場合)、describe-configuration-options コマンド(AWS CLI の場合)を使用します。

たとえば、次のコマンドを実行すると、現在のリージョンでの PHP 5.6 スタックのバージョン 1.4.3 で使用できるインスタンスタイプが一覧表示されます。

$ aws elasticbeanstalk describe-configuration-options --options Namespace=aws:autoscaling:launchconfiguration,OptionName=InstanceType --solution-stack-name "64bit Amazon Linux 2015.03 v1.4.3 running PHP 5.6"

t1.micro

MonitoringInterval

Amazon CloudWatch メトリクスを返す間隔です。

5 minute

1 minute

5 minute

SecurityGroups

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

既存の Amazon EC2 セキュリティグループの名前や、テンプレートで作成した AWS::EC2::SecurityGroup リソースへの参照の名前をカンマで区切り、1 つの文字列として指定することができます。インスタンスが仮想プライベートクラウド(VPC)内で起動されるように、Elastic Beanstalk と共に Amazon VPC を使用している場合は、セキュリティグループ名ではなくセキュリティグループ ID を指定します。

elasticbeanstalk-default

SSHSourceRestriction

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

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

protocol, fromPort, toPort, source_restriction

プロトコル

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

fromPort

開始ポート番号。

toPort

終了ポート番号。

source_restriction

トラフィックの送信元として許可するセキュリティグループの CIDR 範囲または名前。別のアカウントからセキュリティグループを指定するには(EC2-Classic のみ、リージョンが同じである必要があります)、セキュリティグループ名(例: other_account_id/security_group_name)の前にアカウント ID を含めます。

例: tcp, 22, 22, 54.240.196.185/32

例: tcp, 22, 22, my-security-group

例(EC2-Classic): tcp, 22, 22, 0123456789012/their-security-group

なし

BlockDeviceMappings

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

インスタンスストアボリュームをマッピングするときは、ボリューム名にデバイス名をマッピングするのみです。Amazon EBS ボリュームをマッピングするときは、次のフィールドをコロンで区切って指定できます。

  • スナップショット ID

  • サイズ (GB 単位)

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

  • ストレージタイプ (gp2standardst1sc1、または io1)

  • IOPS (io1 ボリュームのみ)。

次の例では、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

プロビジョンド 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 ルートボリュームの場合の 1 秒あたりの入力/出力オペレーション(IOPS)。

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

なし

10020000

aws:autoscaling:scheduledaction

環境の Auto Scaling グループのスケジュールされたアクションを設定します。

名前空間: aws:autoscaling:scheduledaction

名前 説明 デフォルト 有効な値

DesiredCapacity

Auto Scaling group で実行するインスタンスの数。

なし

110000

EndTime

スケジュールに基づくスケーリングアクションを停止する将来の日付と時刻(UTC/GMT タイムゾーン)。

[EndTime] を指定しない場合、終了日時を設定するまで繰り返しが継続されます。

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

ISO-8601 タイムスタンプ形式の詳細については、http://www.w3.org/TR/NOTE-datetime を参照してください。

なし

スケジュールに基づくすべてのスケーリングアクションで一意な日時。

MaxSize

スケジュールに基づくアクションの継続期間内に Auto Scaling group で使用するインスタンスの最大数。

なし

010000

MinSize

スケジュールに基づくアクションの継続期間内に Auto Scaling group で使用するインスタンスの最小数。

なし

010000

繰り返し

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

なし

CRON 式。

CRON の詳細については、「Cron」を参照してください。

StartTime

スケジュールに基づくスケーリングアクションを開始する将来の日付と時刻(UTC/GMT タイムゾーン)。

なし

スケジュールに基づくすべてのアクションで一意な日時を、ISO 8601 時刻形式で指定します。たとえば、2015-04-28T04:07:02Z のように指定します。ISO 8601 時刻形式の詳細については、「Date and Time Formats」を参照してください。

停止

スケジュールに基づくアクションを一時的に停止するかどうか。

false

True

False

注記

スケジュールに基づくスケーリングアクションを設定するときは、スケジュールに基づくスケーリングアクションの名前として、リソース名とともに一意の値を指定します。このリソース名を共有するすべてのオプション設定が、同じスケジュールに基づくアクションに適用されます。(例:

option_settings:
  - namespace: aws:autoscaling:scheduledaction
    resource_name: ScheduledAction01
    option_name: MinSize
    value: 2
  - namespace: aws:autoscaling:scheduledaction
    resource_name: ScheduledAction01
    option_name: MaxSize
    value: 5
  - namespace: aws:autoscaling:scheduledaction
    resource_name: ScheduledAction01
    option_name: StartTime
    value: "2015-05-14T19:25:00Z"

aws:autoscaling:trigger

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

名前空間: aws:autoscaling:trigger

名前 説明 デフォルト 有効な値

BreachDuration

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

5

1600

LowerBreachScaleIncrement

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

-1

LowerThreshold

超過期間に測定値がこの数未満になった場合、トリガが発生します。

2000000

020000000

MeasureName

Auto Scaling トリガに使用されるメトリクスです。

NetworkOut

CPUUtilization

NetworkIn

NetworkOut

DiskWriteOps

DiskReadBytes

DiskReadOps

DiskWriteBytes

Latency

RequestCount

HealthyHostCount

UnhealthyHostCount

間隔

Amazon CloudWatch でトリガのメトリクスを測定する頻度を指定します.

5

統計

Average などの、トリガに使用する Statistic。

Average

Minimum

Maximum

Sum

Average

単位

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 に設定すると、ローリング更新が無効になります。

false

true

false

RollingUpdateType

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

Time

Time

Health

Immutable

PauseTime

Elastic Beanstalk サービスがあるインスタンスのバッチの更新を完了した後、次のバッチを処理するまで待つ時間。

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

PT0S*(0 秒)~PT1H(1 時間)

タイムアウト

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

PT30M (30 分)

PT5M* (5 分)~PT1H(1 時間)

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

aws:ec2:vpc

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

名前空間: aws:ec2:vpc

名前 説明 デフォルト 有効な値

VPCId

VPC の ID。

なし

Subnets

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

なし

ELBSubnets

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

なし

ELBScheme

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

なし

internal

DBSubnets

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

なし

AssociatePublicIpAddress

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

なし

true

false

aws:elasticbeanstalk:application

アプリケーションのヘルスチェックパスを設定します。

名前空間: aws:elasticbeanstalk:application

名前 説明 デフォルト 有効な値

Application Healthcheck URL

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

なし

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

/health

HTTPS:443/

HTTPS:443/health

その他

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

aws:elasticbeanstalk:application:environment

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

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

名前 説明 デフォルト 有効な値

環境変数の名前。

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

なし

環境変数の値。

注記

環境用に定義されるすべての環境プロパティの統合サイズは 4,096 バイトに制限されています。環境プロパティの形式は KEY1=VALUE1, KEY2=VALUE2 で、各変数の値とキーの両方が合計に含まれることを意味します。プラットフォームに 1 つまたは複数の定義済み環境プロパティ([JDBC_CONNECTION_STRING] など)がある場合は、これらのプロパティも合計に含まれます。

aws:elasticbeanstalk:cloudwatch:logs

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

名前空間: aws:elasticbeanstalk:cloudwatch:logs

名前 説明 デフォルト 有効な値

StreamLogs

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

false

true

false

DeleteOnTerminate

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

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 を選択しアプリケーションバージョンをデプロイします。

AllAtOnce

AllAtOnce

Rolling

RollingWithAdditionalBatch

Immutable

タイムアウト

インスタンスが実行コマンドを完了するまで待機する秒数。

"600"

"1""3600"

BatchSizeType

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

Percentage

Percentage

Fixed

BatchSize

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

100

1100 (Percentage).

1aws:autoscaling:asg::MaxSizeFixed)に)

IgnoreHealthCheck

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

false

true

false

HealthCheckSuccessThreshold

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

Ok

Ok

Warning

Degraded

Severe

aws:elasticbeanstalk:environment

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

名前空間: aws:elasticbeanstalk:environment

名前 説明 デフォルト 有効な値

EnvironmentType

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

LoadBalanced

SingleInstance

LoadBalanced

ServiceRole

Elastic Beanstalk が環境のリソースを管理するために使用する IAM ロールの名前。

たとえば、aws-elasticbeanstalk-service-role と指定します。

なし

任意のロール名。

LoadBalancerType

標準ロードバランサーとアプリケーションロードバランサーのいずれかを選択します。

classic

classic

application

aws:elasticbeanstalk:environment:process:default

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

名前空間: aws:elasticbeanstalk:environment:process:default

名前 説明 デフォルト 有効な値

DeregistrationDelay

登録解除前にアクティブなリクエストが完了するまでの待機時間.

20

03600

HealthCheckInterval

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

15

15300

HealthCheckPath

ヘルスチェックの HTTP リクエストを送信するパス。

/

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

HealthCheckTimeout

ヘルスチェック中のレスポンスの待機時間。

5

160

HealthyThresholdCount

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

3

110

MatcherHTTPCode

インスタンスが正常であること示す HTTP コード。

なし

200399

ポート

プロセスがリッスンしているポート。

80

165535

プロトコル

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

HTTP

HTTP

HTTPS

StickinessEnabled

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

'false'

'false'

'true'

StickinessLBCookieDuration

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

86400

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

15300

HealthCheckPath

ヘルスチェックの HTTP リクエストを送信するパス。

/

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

HealthCheckTimeout

ヘルスチェック中のレスポンスの待機時間。

5

160

HealthyThresholdCount

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

3

110

MatcherHTTPCode

インスタンスが正常であること示す HTTP コード。

なし

200399

ポート

プロセスがリッスンしているポート。

80

165535

プロトコル

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

HTTP

HTTP

HTTPS

StickinessEnabled

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

'false'

'false'

'true'

StickinessLBCookieDuration

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

86400

1604800

StickinessType

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

lb_cookie

lb_cookie

UnhealthyThresholdCount

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

5

210

aws:elasticbeanstalk:healthreporting:system

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

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

名前 説明 デフォルト 有効な値

SystemType

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

basic

basic

enhanced

ConfigDocument CloudWatch に発行する環境およびインスタンスメトリクスを定義した JSON ドキュメント。 なし

aws:elasticbeanstalk:hostmanager

更新したログを Amazon S3 にアップロードするように、環境内の EC2 インスタンスを設定します。

名前空間: aws:elasticbeanstalk:hostmanager

名前 説明 デフォルト 有効な値

LogPublicationControl

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

false

true

false

aws:elasticbeanstalk:managedactions

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

名前空間: aws:elasticbeanstalk:managedactions

名前 説明 デフォルト 有効な値

ManagedActionsEnabled

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

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

true

true

false

PreferredStartTime

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

たとえば、"Tue:10:00" と指定します。

なし

曜日と時間を

曜日:時間:

の形式で設定。

aws:elasticbeanstalk:managedactions:platformupdate

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

名前空間: aws:elasticbeanstalk:managedactions:platformupdate

名前 説明 デフォルト 有効な値

UpdateLevel

マネージドプラットフォーム更新で適用される最高レベルの更新。プラットフォームのバージョンはメジャー.マイナー.パッチという形式で 3 つの部分から構成されています。たとえば、2.0.8 はメジャーバージョン 2、マイナーバージョン 0、パッチ バージョン 8 であることを意味します。

なし

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

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

InstanceRefreshEnabled

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

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

false

true

false

aws:elasticbeanstalk:monitoring

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

名前空間: aws:elasticbeanstalk:monitoring

名前 説明 デフォルト 有効な値

Automatically Terminate Unhealthy Instances

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

true

true

false

aws:elasticbeanstalk:sns:topics

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

名前空間: aws:elasticbeanstalk:sns:topics

名前 説明 デフォルト 有効な値

Notification Endpoint

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

なし

Notification Protocol

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

email

http

https

email

email-json

sqs

Notification Topic ARN

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

なし

Notification Topic Name

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

なし

aws:elasticbeanstalk:sqsd

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

名前空間: aws:elasticbeanstalk:sqsd

名前 説明 デフォルト 有効な値

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 インスタンス内のアプリケーションの同時接続の最大数

15

1100

ConnectTimeout

アプリケーションへの接続までの待機時間(秒)

5

160

InactivityTimeout

アプリケーションへの既存の接続で応答するまでの待機時間(秒)

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

180

136000

VisibilityTimeout

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

300

043200

ErrorVisibilityTimeout

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

2

043200

RetentionPeriod

メッセージが有効であり、アクティブに処理される時間(秒)

345600

601209600

MaxRetries

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

10

1100

aws:elb:healthcheck

標準ロードバランサーのヘルスチェックを設定します。

名前空間: aws:elb:healthcheck

名前 説明 デフォルト 有効な値

HealthyThreshold

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

3

210

Interval

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

10

5300

タイムアウト

Elastic Load Balancing が、インスタンスが応答していないと判断するまでの待機時間(秒)。

5

260

UnhealthyThreshold

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

5

210

(廃止された) ターゲット

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

TCP:80

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

aws:elb:loadbalancer

環境の標準ロードバランサーを設定します。

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

名前空間: aws:elb:loadbalancer

名前 説明 デフォルト値 有効な値

CrossZone

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

false

true

false

SecurityGroups

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

なし

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

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 証明書の ARN。

なし

aws:elb:listener

標準ロードバランサーでデフォルトリスナー (ポート 80) を設定します。

名前空間: aws:elb:listener

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

ListenerProtocolHTTP のとき HTTP

ListenerProtocolTCP のとき TCP

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

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

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

true

false

aws:elb:listener:listener_port

標準ロードバランサーの追加リスナーを設定します。

名前空間: aws:elb:listener:listener_port

名前 説明 デフォルト値 有効な値
ListenerProtocol リスナーによって使用されるプロトコルです。 HTTP HTTP HTTPS TCP SSL
InstancePort リスナーが EC2 インスタンスとの通信に使用するポートです。 listener_port と同じです。 165535
InstanceProtocol リスナーが EC2 インスタンスとの通信に使用するプロトコルです。

HTTPListenerProtocolHTTP または HTTPS のとき

TCPListenerProtocolTCP または SSL のとき

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

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

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

SSLCertificateId

リスナーに結合する SSL 証明書の ARN。

なし

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

aws:elb:policies

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

名前空間: aws:elb:policies

名前 説明 デフォルト 有効な値

ConnectionDrainingEnabled

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

false

true

false

ConnectionDrainingTimeout

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

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

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

名前空間: aws:elb:policies:policy_name

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

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

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

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

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

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

なし true false
PublicKey

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

なし
PublicKeyPolicyNames

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

なし
SSLProtocols

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

なし
SSLReferencePolicy

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

なし

Stickiness Cookie Expiration

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

0

01000000

Stickiness Policy

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

false

true false

aws:elbv2: リスナー : デフォルト

アプリケーションロードバランサーのデフォルトのリスナー (ポート 80) を設定します。

名前空間: aws:elbv2:listener:default

名前 説明 デフォルト 有効な値

DefaultProcess

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

default

プロセス名。

ListenerEnabled

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

true

true

false

ルール

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

なし

ルール名のカンマ区切りリスト。

aws:elbv2:listener:listener_port

アプリケーションロードバランサーに追加のリスナーを設定します。

名前空間: aws:elbv2:listener:listener_port

名前 説明 デフォルト 有効な値

DefaultProcess

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

default

プロセス名。

ListenerEnabled

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

true

true

false

プロトコル

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

HTTP

HTTP

HTTPS

ルール

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

なし

ルール名のカンマ区切りリスト。

SSLCertificateArns

リスナーに結合する SSL 証明書の ARN。

なし

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

SSLPolicy

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

なし (ELB のデフォルト)

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

aws:elbv2:listenerrule:rule_name

リスナールールをアプリケーションロードバランサーに追加します。

名前空間: aws:elbv2:listenerrule:rule_name

名前 説明 デフォルト 有効な値

PathPatterns

一致させるパスパターンのリスト。たとえば、/img/* と指定します。

なし

優先度

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

1

11000

プロセス

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

default

プロセス名。

aws:elbv2:loadbalancer

アプリケーションロードバランサーを設定します。

名前空間: 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 が作成するセキュリティグループ。

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

aws:rds:dbinstance

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

名前空間: aws:rds:dbinstance

名前 説明 デフォルト 有効な値

DBAllocatedStorage

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

MySQL: 5

Oracle: 10

sqlserver-se: 200

sqlserver-ex: 30

sqlserver-web: 30

MySQL: 5-1024

Oracle: 10-1024

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

DBDeletionPolicy

環境の終了時に、DB インスタンスを削除するか、そのスナップショットを取得するかを決定します。

警告

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

Delete

Delete

Snapshot

DBEngine

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

mysql

mysql

oracle-se1

oracle-se

oracle-ee

sqlserver-ee

sqlserver-ex

sqlserver-web

sqlserver-se

postgres

DBEngineVersion

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

5.5

DBInstanceClass

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

db.t1.micro

Amazon Relational Database Service User Guide」の「DB Instance Class」を参照してください。

DBPassword

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

なし

DBSnapshotIdentifier

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

なし

DBUser

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

ebroot

MultiAZDatabase

データベースインスタンス Multi-AZ デプロイを作成する必要があるかどうかを指定します。Multi-AZ デプロイと Amazon Relational Database Service(RDS)の詳細については、「 Amazon Relational Database Service User Guide」の「Regions and Availability Zones」を参照してください。

false

true

false