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

運用

注記

このツール、Elastic Beanstalk API CLI、およびそのドキュメントは、AWS CLI で置き換えられました。AWS CLI の使用を開始するには、AWS CLI ユーザーガイドを参照してください。また、簡略化された高レベルのコマンドラインの経験を得るには、EB CLI をお試しください。

elastic-beanstalk-check-dns-availability

説明

指定した CNAME を使用できるかどうかを確認します。

構文

elastic-beanstalk-check-dns-availability -c [CNAMEPrefix]

オプション

名前 説明 必須

-c

--cname-prefix CNAMEPrefix

確認する CNAME の名前。

型: 文字列

デフォルト: なし

はい

出力

次の情報を含むテーブルが返されます。

  • Available – CNAME を使用できる場合はtrue、使用できない場合は false が表示されます。

  • FullyQualifiedCNAME – CNAME を使用できる場合は完全修飾名の CNAME、使用できない場合は N/A が表示されます。

CNAME を使用できるかどうかを確認する

この例は、CNAME プレフィックスの「myapp23」を使用できるかどうかを確認する方法を示します。

PROMPT> elastic-beanstalk-check-dns-availability -c myapp23

elastic-beanstalk-create-application

説明

default という 1 つの設定テンプレートがあり、アプリケーションバージョンがないアプリケーションを作成します。

注記

この default 設定テンプレートは、Tomcat 6 アプリケーションコンテナを実行している 32 ビットバージョンの Amazon Linux オペレーティングシステム用です。

構文

elastic-beanstalk-create-application -a [name] -d [desc]

オプション

名前 説明 必須

-a

--application-name name

アプリケーションの名前。

制限: この名前はアカウント内で一意にする必要があります。指定した名前がすでに存在する場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

はい

-d

--description desc

アプリケーションの説明。

型: 文字列

デフォルト: なし

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – アプリケーションの名前。この名前のアプリケーションが見つからず、AutoCreateApplicationfalse の場合、InvalidParameterValue エラーが返されます。

  • ConfigurationTemplates – アプリケーションの作成に使用された設定テンプレートの一覧。

  • DateCreated – アプリケーションが作成された日付。

  • DateUpdated – アプリケーションが更新された日付。

  • Description – アプリケーションの説明。

  • Versions – アプリケーションのバージョン。

アプリケーションを作成する

この例は、アプリケーションを作成する方法を示します。


PROMPT> elastic-beanstalk-create-application -a MySampleApp -d "My description"

elastic-beanstalk-create-application-version

説明

指定したアプリケーションのアプリケーションバージョンを作成します。

注記

指定した Amazon S3 バケットとキーの場所を使用してアプリケーションバージョンを作成した後は、その Amazon S3 の場所を変更できません。Amazon S3 の場所を変更した場合、そのアプリケーションバージョンから環境を起動しようとすると、例外を受け取ります。

構文

elastic-beanstalk-create-application-version -a [name] -l [label] -c -d [desc] -s [location]

オプション

名前 説明 必須

-a

--application-name name

アプリケーションの名前。この名前のアプリケーションが見つからず、AutoCreateApplicationfalse の場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-c

--auto-create

このバージョンの指定したアプリケーションが存在しない場合のシステムの動作を指定します。

  • true: このリリースの指定したアプリケーションが存在しない場合は、自動的に作成します。

  • false: このリリースの指定したアプリケーションが存在しない場合は、InvalidParameterValue をスローします。

タイプ: ブール値

有効な値: true | false

デフォルト: false

いいえ

-d

--description desc

バージョンの説明。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 0 です。最大値は 200 です。

いいえ

-l

--version-label label

このバージョンを識別するラベル。

型: 文字列

デフォルト: なし

制限: アプリケーションごとに一意である必要があります。指定したアプリケーションに、このラベルのアプリケーションバージョンがすでに存在する場合、InvalidParameterValue エラーが返されます。

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-s

--source-location location

このバージョンのソースバンドルの場所を識別する Amazon S3 バケットの名前とキー。bucketname/key という形式です。

Amazon S3 の場所に見つかったデータが、ソースバンドルに許可されている最大サイズを超えている場合、InvalidParameterCombination エラーが返されます。

型: 文字列

デフォルト: 指定しない場合、サンプルアプリケーションが使用されます。一部が指定されている場合(例えば、バケットを指定してキーは指定しないなど)、または指定した Amazon S3 の場所にデータが見つからなかった場合、InvalidParameterCombination エラーが返されます。

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – アプリケーションの名前。

  • DateCreated – アプリケーションが作成された日付。

  • DateUpdated – アプリケーションが更新された日付。

  • Description – アプリケーションの説明。

  • SourceBundle – このバージョンのソースバンドルが見つかった場所。

  • VersionLabel – 関連付けられたアプリケーションのバージョンを一意に識別するラベル。

ソースの場所からバージョンを作成する

この例は、ソースの場所からバージョンを作成する方法を示します。


PROMPT> elastic-beanstalk-create-application-version -a MySampleApp -d "My version" -l "TestVersion 1" -s amazonaws.com/sample.war

elastic-beanstalk-create-configuration-template

説明

設定テンプレートを作成します。テンプレートは特定のアプリケーションと関連付けられ、異なるバージョンのアプリケーションを同じ設定でデプロイするために使用されます。

構文

elastic-beanstalk-create-configuration-template -a [name] -t [name] -E [id] -d [desc] -s [stack] -f [filename] -A [name] -T [name]

オプション

名前 説明 必須

-a

--application-name name

この設定テンプレートに関連付けるアプリケーションの名前。この名前のアプリケーションが見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

はい

-t

--template-name name

設定テンプレートの名前。この名前の設定テンプレートが存在しない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

制限: このアプリケーションで一意にする必要があります。

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-E

--environment-id id

設定テンプレートの環境 ID。

型: 文字列

デフォルト: なし

いいえ

-d

--description desc

設定の説明。

型: 文字列

デフォルト: なし

いいえ

-s

--solution-stack スタック

この設定で使用されるソリューションスタックの名前。ソリューションスタックでは、設定テンプレートのオペレーティングシステム、アーキテクチャ、アプリケーションサーバーを指定します。ソリューションスタックによって、設定オプション、使用できる値、デフォルト値が決まります。

elastic-beanstalk-list-available-solution-stacks を使用して、使用できるソリューションスタックの一覧を取得します。

ソリューションスタック名またはソース設定パラメータを指定する必要があります。指定しない場合、InvalidParameterValue エラーが返されます。

ソリューションスタック名が指定されておらず、ソース設定パラメータが指定されている場合、ソース設定テンプレートと同じソリューションスタックが使用されます。

型: 文字列

長さの制限: 最小値は 0 です。最大値は 100 です。

いいえ

-f

--options-file filename

設定テンプレートの設定オプションを定義した一連のキーと値のペアを含む JSON ファイルの名前。ソリューションスタックまたはソース設定テンプレートから取得した値は、新しい値で上書きされます。

型: 文字列

いいえ

-A

--source-application-name name

この設定テンプレートのソースとして使用するアプリケーションの名前。

型: 文字列

デフォルト: なし

いいえ

-T

--source-template-name name

この設定テンプレートのソースとして使用するテンプレートの名前。

型: 文字列

デフォルト: なし

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – 設定セットと関連付けられているアプリケーションの名前。

  • DateCreated – この設定セットが作成された日付(UTC 時間)。

  • DateUpdated – この設定セットが最後に変更された日付(UTC 時間)。

  • DeploymentStatus – この設定セットが環境に関連付けられている場合、デプロイステータスパラメータは、この設定セットのデプロイステータスを示します。

    • null: この設定は実行中の環境と関連付けられています。

    • pending: これは、関連付けられた環境にデプロイされておらず、デプロイの処理中であるドラフト設定です。

    • deployed: これは、関連付けられた実行中の環境に現在デプロイされている設定です。

    • failed: これは、正常にデプロイされなかったドラフト設定です。

  • Description – 設定セットの説明。

  • EnvironmentNamenull ではない場合、この設定セットの環境の名前。

  • OptionSettings – この設定セットの設定オプションと値の一覧。

  • SolutionStackName – この設定セットが使用するソリューションスタックの名前。

  • TemplateNamelnull ではない場合、この設定セットの設定テンプレートの名前。

基本的な設定テンプレートを作成する

この例は、基本的な設定テンプレートを作成する方法を示します。設定の一覧については、「設定オプション」を参照してください。


PROMPT> elastic-beanstalk-create-configuration-template -a MySampleApp -t myconfigtemplate -E e-eup272zdrw

elastic-beanstalk-create-environment

説明

指定した設定を使用して、指定したアプリケーションの環境を起動します。

構文

elastic-beanstalk-create-environment -a [name] -l [label] -e [name] [-t [name] | -s [stack]] -c [prefix] -d [desc] -f[filename] -F [filename]

オプション

名前 説明 必須

-a

--application-name name

デプロイするバージョンを含むアプリケーションの名前。この名前のアプリケーションが見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-l

--version-label >label

デプロイするアプリケーションバージョンの名前。

指定したアプリケーションにアプリケーションバージョンが関連付けられていない場合、Elastic Beanstalk UpdateEnvironment から InvalidParameterValue エラーが返されます。

デフォルト: 指定されていない場合、Elastic Beanstalk はコンテナ内のサンプルアプリケーションを起動します。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-e

--environment-name name

デプロイ環境の一意の名前。アプリケーション URL で使用されます。

制限: 4~23 文字の長さにする必要があります。名前には、英字、数字、ハイフンのみを使用できます。ハイフンを先頭または末尾に付けることはできません。この名前はアカウント内で一意にする必要があります。指定した名前がすでに存在する場合、InvalidParameterValue が返されます。

型: 文字列

デフォルト: CNAME パラメータが指定されていない場合、環境名が CNAME の一部に使用され、表示されるアプリケーションの URL の一部にもなります。

はい

-t

--template-name name

デプロイで使用する設定テンプレートの名前。この名前の設定テンプレートが見つからない場合、InvalidParameterValue エラーが返されます。

条件: このパラメータとソリューションスタック名の両方ではなく、いずれかを指定する必要があります。両方を指定すると、InvalidParameterValue エラーが返されます。いずれも指定しない場合、MissingRequiredParameter が返されます。

型: 文字列

デフォルト: なし

制限: このアプリケーションで一意にする必要があります。

条件付き

-s

--solution-stack スタック

設定名を指定する代わりのパラメータです。指定した場合、その設定値は、指定したソリューションスタックに関連付けられたデフォルト値に設定されます。

条件: このパラメータと TemplateName の両方ではなく、いずれかを指定する必要があります。両方を指定すると、InvalidParameterCombination エラーが返されます。いずれも指定しない場合、MissingRequiredParameter エラーが返されます。

型: 文字列

デフォルト: なし

条件付き

-c

--cname-prefix プレフィックス

指定した場合、環境は CNAME のプレフィックスとしてこの値の使用を試みます。指定しない場合、環境は環境名を使用します。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

いいえ

-d

--description desc

環境の説明。

型: 文字列

デフォルト: なし

いいえ

-f

--options-file filename

この新しい環境の設定オプションを定義した一連のキーと値のペアを含む JSON ファイルの名前。ソリューションスタックまたはソース設定テンプレートから取得した値は、この値で上書きされます。

型: 文字列

いいえ

-F

--options-to-remove-file

この新しい環境の設定から削除する設定オプションを含む JSON ファイルの名前。

型: 文字列

デフォルト: なし

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – この環境に関連付けられたアプリケーションの名前。

  • CNAME – この環境の CNAME の URL。

  • DateCreated – 環境が作成された日付。

  • DateUpdated – 環境が最後に更新された日付。

  • Description – 環境の説明。

  • EndpointURL – この環境の LoadBalancer の URL。

  • EnvironmentID – この環境の ID。

  • EnvironmentName – この環境の名前。

  • Health – 環境のヘルスステータスの説明。Elastic Beanstalk は実行中の環境のエラーレベルを示します。

    • Red: 環境が応答しないことを示します。1 つの環境について、3 個以上の連続するエラーが発生したときに表示されます。

    • Yellow: 何らかの問題が発生していることを示します。1 つの環境について、2 個以上の連続するエラーが発生したときに表示されます。

    • Green: 環境が正常な状態で、完全に機能していることを示します。

    • Gray: 新しい環境のデフォルトのヘルス。環境は完全に起動していないため、ヘルスチェックがか開始されていないか、UpdateEnvironment または RestartEnvironment リクエスト中でヘルスチェックが一時停止されています。

  • Resources – この環境で使用されている AWS リソースの一覧。

  • SolutionStackName – この環境にデプロイされているソリューションスタックの名前。

  • Status – 環境の現在のオペレーションステータス。

    • Launching: 環境は、初期デプロイのプロセス中です。

    • Updating: 環境は、設定またはアプリケーションバージョンを更新するプロセス中です。

    • Ready: 環境は、更新や終了などのアクションを実行できる状態です。

    • Terminating: 環境はシャットダウンプロセス中です。

    • Terminated: 環境は実行中ではありません。

  • TemplateName – この環境の起動に元々使用されていた設定テンプレートの名前。

  • VersionLabel – この環境にデプロイされているアプリケーションバージョン。

基本的な設定テンプレートを使用して環境を作成する

この例は、基本的な設定テンプレートを使用して環境を作成し、設定を編集する 1 つのファイルと、設定を削除する 1 つのファイルという形式で渡します。設定の一覧については、「設定オプション」を参照してください。

$ elastic-beanstalk-create-environment -a MySampleApp -t myconfigtemplate -e MySampleAppEnv -f options.txt -F options_remove.txt

options.txt

[
    {
        "Namespace": "aws:autoscaling:asg",
        "OptionName": "MinSize",
        "Value": "2"
    },
    {
        "Namespace": "aws:autoscaling:asg",
        "OptionName": "MaxSize",
        "Value": "3"
    }
]

options_remove.txt

[
    {
        "Namespace": "aws:elasticbeanstalk:sns:topics",
        "OptionName": "PARAM4"
    }
]

elastic-beanstalk-create-storage-location

説明

このアカウント用に Amazon S3 ストレージの場所を作成します。この場所は、ユーザーログファイルの保存に使用されます。また、AWS マネジメントコンソールがアプリケーションバージョンをアップロードするときに使用されます。Elastic Beanstalk を操作するためにこのバケットを作成する必要はありません。

構文

elastic-beanstalk-create-storage-location

ストレージの場所を作成する

この例は、ストレージの場所を作成する方法を示します。


PROMPT> elastic-beanstalk-create-storage-location

このコマンドを使用すると、作成された Amazon S3 バケットの名前が出力されます。

elastic-beanstalk-delete-application

説明

指定したアプリケーションと、すべての関連するバージョンと設定を削除します。

注記

実行中の環境があるアプリケーションは削除できません。

構文

elastic-beanstalk-delete-application -a [name] -f

オプション

名前 説明 必須

-a

--application-name name

削除するアプリケーションの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-f

--force-terminate-env

アプリケーションを削除する前に、実行中の環境がすべて削除されているかどうかを判断します。

タイプ: ブール値

有効な値: true | false

デフォルト: false

いいえ

出力

コマンドは文字列 Application deleted. を返します。

アプリケーションを削除する

この例は、アプリケーションを削除する方法を示します。


PROMPT> elastic-beanstalk-delete-application -a MySampleApp

elastic-beanstalk-delete-application-version

説明

指定したアプリケーションから、指定したアプリケーションを削除します。

注記

実行中の環境に関連付けられているアプリケーションは削除できません。

構文

elastic-beanstalk-delete-application-version -a [name] -l [label] -d

オプション

名前 説明 必須

-a

--application-name name

リリースを削除するアプリケーションの名前。

型: 文字列

デフォルト: なし

はい

-l

--version-label

削除するバージョンのラベル。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-d

--delete-source-bundle

関連付けられたソースバンドルを Amazon S3 から削除するかどうかを指定します。

true: 作成の時点で指定されていた、関連付けられた Amazon S3 ソースバンドルを削除しようとしました。

false : 作成の時点で指定されていた Amazon S3 ソースバンドルに対して、実行されているアクションがありません。

タイプ: ブール値

有効な値: true | false

デフォルト: false

いいえ

出力

コマンドは文字列 Application version deleted. を返します。

アプリケーションバージョンを削除する

この例は、アプリケーションバージョンを削除する方法を示します。


PROMPT> elastic-beanstalk-delete-application-version -a MySampleApp -l MyAppVersion

アプリケーションバージョンと Amazon S3 ソースバンドルを削除する

この例は、アプリケーションバージョンを削除する方法を示します。


PROMPT> elastic-beanstalk-delete-application-version -a MySampleApp -l MyAppVersion -d

elastic-beanstalk-delete-configuration-template

説明

指定した設定テンプレートを削除します。

注記

設定テンプレートを使用して環境を起動すると、そのテンプレートのコピーが環境用に作成されます。環境用のテンプレートのコピーは、実行中の環境に影響を与えることなく、削除または変更することができます。

構文

elastic-beanstalk-delete-configuration-template -a [name] -t [name]

オプション

名前 説明 必須

-a

--application-name name

設定テンプレートを削除するアプリケーションの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-t

--template-name

削除する設定テンプレートの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

出力

コマンドは文字列 Configuration template deleted. を返します。

設定テンプレートを削除する

この例は、設定テンプレートを削除する方法を示します。


PROMPT> elastic-beanstalk-delete-configuration-template -a MySampleApp -t MyConfigTemplate

elastic-beanstalk-delete-environment-configuration

説明

実行中に関連付けられているドラフト設定を削除します。

注記

設定の変更によって実行中の環境を更新すると、ドラフト設定セットが作成されます。更新が進行中の場合、または更新が失敗した場合に、elastic-beanstalk-describe-configuration-settings を使用してドラフト設定を取得することができます。ドラフト設定のデプロイステータスは、デプロイが進行中か失敗したかを示します。ドラフトの設定は、このアクションで削除するまで残ります。

構文

elastic-beanstalk-delete-environment-configuration -a [name] -e [name]

オプション

名前 説明 必須

-a

--application-name name

この環境が関連付けられたアプリケーションの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-e

--environment-name name

ドラフト設定を削除する環境の名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

はい

出力

コマンドは文字列 Environment configuration deleted. を返します。

設定テンプレートを削除する

この例は、設定テンプレートを削除する方法を示します。


PROMPT> elastic-beanstalk-delete-environment-configuration -a MySampleApp -e MyEnvConfig

elastic-beanstalk-describe-application-versions

説明

既存のアプリケーションバージョンに関する情報を返します。

構文

elastic-beanstalk-describe-application-versions -a [name] -l [labels [,label..]]

オプション

名前 説明 必須

-a

--application-name

アプリケーションの名前。指定した場合、返される説明には、指定したアプリケーションに関連付けられている説明のみを含むように制限されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-l

--version-label labels

バージョンラベルのコンマ区切りの一覧。指定した場合、返される説明には、指定したバージョンラベルのアプリケーションの説明のみを含むように制限されます。

型: 文字列[]

デフォルト: なし

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – このリリースに関連付けられたアプリケーションの名前。

  • DateCreated – アプリケーションが作成された日付。

  • DateUpdated – アプリケーションバージョンが最後に更新された日付。

  • Description – アプリケーションバージョンの説明。

  • SourceBundle – このバージョンのソースバンドルが見つかった場所。

  • VersionLabel – 関連付けられたアプリケーションのバージョンを一意に識別するラベル。

アプリケーションバージョンについて説明する

この例は、このアカウントのすべてのアプリケーションバージョンについて説明する方法を示します。


PROMPT> elastic-beanstalk-describe-application-versions

指定したアプリケーションのアプリケーションバージョンについて説明する

この例は、指定したアプリケーションのアプリケーションバージョンについて説明する方法を示します。


PROMPT> elastic-beanstalk-describe-application-versions -a MyApplication

複数のアプリケーションバージョンについて説明する

この例は、指定した複数のアプリケーションバージョンについて説明する方法を示します。


PROMPT> elastic-beanstalk-describe-application-versions -l MyAppVersion1, MyAppVersion2

elastic-beanstalk-describe-applications

説明

説明と既存のアプリケーションを返します。

構文

elastic-beanstalk-describe-applications -a [names [,name..]]

オプション

名前 説明 必須

-a

--application-names name

1 つまたは複数のアプリケーションの名前。複数の場合はコンマで区切ります。指定した場合、返される説明には、指定した名前のアプリケーションの説明のみを含むように制限されます。

型: 文字列[]

デフォルト: なし

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – アプリケーションの名前。

  • ConfigurationTemplates – アプリケーションの作成に使用された設定テンプレートの一覧。

  • DateCreated – アプリケーションが作成された日付。

  • DateUpdated – アプリケーションが更新された日付。

  • Description – アプリケーションの説明。

  • Versions – このアプリケーションのバージョンの名前。

アプリケーションについて説明する

この例は、このアカウントのすべてのアプリケーションについて説明する方法を示します。


PROMPT> elastic-beanstalk-describe-applications

特定のアプリケーションについて説明する

この例は、特定のアプリケーションについて説明する方法を示します。


PROMPT> elastic-beanstalk-describe-applications -a MyApplication

elastic-beanstalk-describe-configuration-options

説明

特定の設定テンプレートまたは環境で使用されている設定オプション、または指定したソリューションスタックに定義されている設定オプションについて説明します。説明には、値、オプション、オプションのデフォルト値、オプションの値が変更された場合に実行中の環境で実行する必要があるアクションが含まれます。

構文

elastic-beanstalk-describe-configuration-options -a [name] -t [name] -e [name] -s [stack] -f [filename]

オプション

名前 説明 必須

-a

--application-name name

設定テンプレートまたは環境に関連付けられているアプリケーションの名前。設定テンプレートまたは環境に関連付けられている設定オプションについて説明する場合にのみ、必要です。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-t

--template-name name

説明する設定オプションがある設定テンプレートの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-e

--environment-name name

説明する設定オプションがある環境の名前。

型: 文字列

長さの制限: 最小値は 4 です。最大値は 23 です。

いいえ

-s

--solution-stack スタック

説明する設定オプションがあるソリューションスタックの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 0 です。最大値は 100 です。

いいえ

-f

--options-file filename

説明するオプションを含む JSON ファイルの名前。

型: 文字列

いいえ

出力

次の情報を含むテーブルが返されます。

  • Options – 設定オプションの一覧。

  • SolutionStackName – これらの設定オプションが属する SolutionStack の名前。

環境の設定オプションについて説明する

この例は、環境の設定オプションについて説明する方法を示します。


PROMPT> elastic-beanstalk-describe-configuration-options -a MySampleApp -t myconfigtemplate -e MySampleAppEnv

elastic-beanstalk-describe-configuration-settings

説明

指定した設定セット(実行中の環境に関連付けられている設定テンプレートまたは設定セット)の設定の説明を返します。

実行中の環境に関連付けられた設定セットの設定について説明しているときは、設定している説明を 2 組受け取る可能性があります。1 つはデプロイ済みの設定セットで、もう 1 つは、デプロイプロセス中またはデプロイに失敗した環境のドラフト設定です。

構文

elastic-beanstalk-describe-configuration-settings -a [name] [-t [name] | -e [name]]

オプション

名前 説明 必須

-a

--application-name name

環境または設定テンプレートのアプリケーションの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-t

--template-name name

説明する設定テンプレートの名前。この名前の設定テンプレートが見つからない場合、InvalidParameterValue エラーが返されます。

条件: このパラメータと環境名の両方ではなく、いずれかを指定する必要があります。両方を指定すると、InvalidParameterValue エラーが返されます。いずれも指定しない場合、MissingRequiredParameter エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

条件付き

-e

--environment-name name

説明する環境の名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

条件付き

出力

次の情報を含むテーブルが返されます。

  • ConfigurationSettings – 設定の一覧。

環境の設定について説明する

この例は、環境の設定オプションについて説明する方法を示します。


PROMPT> elastic-beanstalk-describe-configuration-settings -a MySampleApp -e MySampleAppEnv

elastic-beanstalk-describe-environment-resources

説明

この環境の AWS リソースを返します。

構文

elastic-beanstalk-describe-environment-resources [-e [name] | -E [id]]

オプション

名前 説明 必須

-e

--environment-name name

AWS リソース使用状況データを取得する環境の名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

条件付き

-E

--environment-id id

AWS リソース使用状況データを取得する環境の ID。

型: 文字列

デフォルト: なし

条件付き

出力

次の情報を含むテーブルが返されます。

  • AutoScalingGroups – この環境で使用されている AutoScalingGroups の一覧。

  • EnvironmentName – 環境の名前。

  • Instances – この環境で使用されている Amazon EC2 インスタンス。

  • LaunchConfigurations – この環境で使用されている Auto Scaling の起動設定。

  • LoadBalancers – この環境で使用されている LoadBalancers。

  • Triggers – この環境で使用されている AutoScaling トリガ。

環境の環境リソースについて説明する

この例は、環境の環境リソースについて説明する方法を示します。


PROMPT> elastic-beanstalk-describe-environment-resources -e MySampleAppEnv

elastic-beanstalk-describe-environments

説明

既存の環境に関する説明を返します。

構文

elastic-beanstalk-describe-environments -e [names [,name...]] -E [ids [,id...]] -a [name] -l [label] -d -D [timestamp]

オプション

名前 説明 必須

-e

--environment-names names

環境名の一覧。

型: 文字列[]

デフォルト: なし

いいえ

-E

--environment-ids ids

環境 ID の一覧。

型: 文字列[]

デフォルト: なし

いいえ

-a

--application-name name

アプリケーションに関連付けられている説明の一覧。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-l

--version-label >label

アプリケーションバージョンに関連付けられている説明の一覧。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-d

--include-deleted

削除された環境を含めるかどうかを指定します。

true : --include-deleted-back-to の後に削除された環境が表示されます。

false: 削除された環境を含めません。

タイプ: ブール値

デフォルト: true

いいえ

-D

--include-deleted-back-to timestamp

--include-deleted が true に設定されている場合、この日付の後に削除された環境の一覧が表示されます。

タイプ: 日付時刻

デフォルト: なし

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – この環境に関連付けられたアプリケーションの名前。

  • CNAME – この環境の CNAME の URL。

  • DateCreated – 環境が作成された日付。

  • DateUpdated – 環境が最後に更新された日付。

  • Description – 環境の説明。

  • EndpointURL – この環境の LoadBalancer の URL。

  • EnvironmentID – この環境の ID。

  • EnvironmentName – この環境の名前。

  • Health – 環境のヘルスステータスの説明。Elastic Beanstalk は実行中の環境のエラーレベルを示します。

    • Red: 環境が応答しないことを示します。1 つの環境について、3 個以上の連続するエラーが発生したときに表示されます。

    • Yellow: 何らかの問題が発生していることを示します。1 つの環境について、2 個以上の連続するエラーが発生したときに表示されます。

    • Green: 環境が正常な状態で、完全に機能していることを示します。

    • Gray: 新しい環境のデフォルトのヘルス。環境は完全に起動していないため、ヘルスチェックがか開始されていないか、UpdateEnvironment または RestartEnvironment リクエスト中でヘルスチェックが一時停止されています。

  • Resources – この環境で使用されている AWS リソースの一覧。

  • SolutionStackName – この環境でデプロイされている SolutionStack の名前。

  • Status – 環境の現在のオペレーションステータス。

    • Launching: 環境は、初期デプロイのプロセス中です。

    • Updating: 環境は、設定またはアプリケーションバージョンを更新するプロセス中です。

    • Ready: 環境は、更新や終了などのアクションを実行できる状態です。

    • Terminating: 環境はシャットダウンプロセス中です。

    • Terminated: 環境は実行中ではありません。

  • TemplateName – この環境の起動に元々使用されていた設定テンプレートの名前。

  • VersionLabel – この環境にデプロイされているアプリケーションバージョン。

環境について説明する

この例は、既存の環境について説明する方法を示します。


PROMPT> elastic-beanstalk-describe-environments

elastic-beanstalk-describe-events

説明

最長で過去 6 週間について、条件と一致するイベントの説明の一覧を返します。

注記

このアクションは、指定した NextToken から過去 1,000 件のイベントを返します。

構文

elastic-beanstalk-describe-events -a [name] -e [name] -E [id] -l [label] -L [timestamp] -m [count] -n [token] -r [id] -s [level] -S [timestamp] -t [name]

オプション

名前 説明 必須

-a

--application-name name

アプリケーションの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-e

--environment-name name

環境の名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

いいえ

-E

--environment-id id

環境の ID。

型: 文字列

デフォルト: なし

いいえ

-l

--version-label >label

アプリケーションバージョン。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-L

--end-time timestamp

指定した場合、指定した時間よりも前に発生したイベントの一覧が返されます。

タイプ: 日付時刻

デフォルト: なし

いいえ

-m

--max-records count

最大で過去何件のイベントを返すことができるかを指定します。

タイプ: 整数

デフォルト: なし

いいえ

-n

--next-token token

ページ分割トークン。結果の次のバッチを返すために使用されます。

型: 文字列

デフォルト: なし

いいえ

-r

--request-id id

リクエスト ID。

型: 文字列

デフォルト: なし

いいえ

-s

--severity レベル

指定した場合、指定した重大度以上のイベント一覧が返されます。

型: 文字列

有効な値: TRACE | DEBUG | INFO | WARN | ERROR | FATAL

デフォルト: なし

いいえ

-S

--start-time timestamp

指定した場合、指定した時間の後に発生したイベントの一覧が返されます。

タイプ: 日付時刻

デフォルト: なし

いいえ

-t

--template-name name

設定テンプレートの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – イベントに関連付けられたアプリケーションの名前。

  • EnvironmentName – イベントに関連付けられた環境の名前。

  • EventDate – イベントの日付。

  • Message – イベントのメッセージ。

  • RequestID – このイベントのアクティビティのウェブサービスリクエスト ID。

  • Severity – イベントの重大度。

  • TemplateName – このイベントに関連付けられている設定の名前。

  • VersionLabel – このイベントに関連付けられているアプリケーションのリリースラベル。

環境のイベントとセキュリティレベルについて説明する

この例は、環境の重大度が WARN 以上のイベントについて説明する方法について説明します。


PROMPT> elastic-beanstalk-describe-events -e MySampleAppEnv -s WARN

elastic-beanstalk-list-available-solution-stacks

説明

使用できるソリューションスタック名の一覧を返します

構文

elastic-beanstalk-list-available-solution-stacks

出力

使用できるソリューションスタック名の一覧を返します。

使用できるソリューションスタックの一覧を表示する

この例は、使用できるソリューションスタックの一覧を取得する方法を示します。


PROMPT> elastic-beanstalk-list-available-solution-stacks

elastic-beanstalk-rebuild-environment

説明

指定した環境について、すべての AWS リソース(例えば、Auto Scaling グループ、LoadBalancer など)を削除して再作成し、強制的に再起動します。

構文

elastic-beanstalk-rebuild-environment [-e [name] | -E [id]]

オプション

名前 説明 必須

-e

--environment-name name

再構築する環境の名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

条件付き

-E

--environment-id id

再構築する環境の ID。

型: 文字列

デフォルト: なし

条件付き

出力

Rebuilding environment が出力されます。

環境を再構築する

この例は、環境を再構築する方法を示します。


PROMPT> elastic-beanstalk-rebuild-environment -e MySampleAppEnv

elastic-beanstalk-request-environment-info

説明

デプロイ済み環境の指定した種類の情報をコンパイルするリクエストを開始します。

InfoType を tail に設定すると、環境に含まれる各 Amazon EC2 インスタンスのアプリケーションサーバーログファイルから、最新の行がコンパイルされます。コンパイルされた情報にアクセスするには、RetrieveEnvironmentInfo を使用します。

構文

elastic-beanstalk-request-environment-info [-e [name] | -E [id]] -i [type]

オプション

名前 説明 必須

-e

--environment-name name

リクエストしたデータの環境の名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

条件付き

-E

--environment-id id

リクエストしたデータの環境の ID。

型: 文字列

デフォルト: なし

条件付き

-i

--info-type type

リクエストする情報の種類。

型: 文字列

有効な値: tail

デフォルト: なし

はい

環境情報をリクエストする

この例は、環境情報をリクエストする方法を示します。


PROMPT> elastic-beanstalk-request-environment-info -e MySampleAppEnv -i tail

elastic-beanstalk-restart-app-server

説明

各 Amazon EC2 インスタンスで実行されている環境のアプリケーションコンテナサーバーを再起動します。

構文

elastic-beanstalk-restart-app-server [-e [name] | -E [id]]

オプション

名前 説明 必須

-e

--environment-name name

サーバーを再起動する環境の名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

条件付き

-E

--environment-id id

サーバーを再起動する環境の ID。

型: 文字列

デフォルト: なし

条件付き

アプリケーションサーバーを再起動する

この例は、アプリケーションサーバーを再起動する方法を示します。


PROMPT> elastic-beanstalk-restart-app-server -e MySampleAppEnv

elastic-beanstalk-retrieve-environment-info

説明

RequestEnvironmentInfo リクエストから、コンパイル済み情報を取得します。

構文

elastic-beanstalk-retrieve-environment-info [-e [name] | -E [id]] -i [type]

オプション

名前 説明 必須

-e

--environment-name name

データの環境の名前。環境が見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

条件付き

-E

--environment-id id

データの環境の ID。

データの環境の名前。環境が見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

条件付き

-i

--info-type type

取得する情報の種類。

型: 文字列

有効な値: tail

デフォルト: なし

はい

出力

次の情報を含むテーブルが返されます。

  • EC2InstanceId – この情報に関する Amazon EC2 インスタンス ID。

  • InfoType – 取得した情報の種類。

  • Message – 取得した情報。

  • SampleTimestamp – この情報を取得した時刻のタイムスタンプ。

環境情報を取得する

この例は、環境情報を取得する方法を示します。


PROMPT> elastic-beanstalk-retrieve-environment-info -e MySampleAppEnv -i tail

elastic-beanstalk-swap-environment-cnames

説明

2 つの環境の CNAME を交換します。

構文

elastic-beanstalk-swap-environment-cnames [-s [name] | -S [desc]] [-d [desc] | -D [desc]]

オプション

名前 説明 必須

-s

--source-environment-name name

ソース環境の名前。

型: 文字列

デフォルト: なし

条件付き

-S

--source-environment-id id

ソース環境の ID。

型: 文字列

デフォルト: なし

条件付き

-d

--destination-environment-name name

対象環境の名前。

型: 文字列

デフォルト: なし

条件付き

-D

--destination-environment-id id

対象環境の ID。

型: 文字列

デフォルト: なし

条件付き

環境の CNAME を交換する

この例は、2 つの環境の CNAME を交換する方法を示します。


PROMPT> elastic-beanstalk-swap-environment-cnames -s MySampleAppEnv -d MySampleAppEnv2

elastic-beanstalk-terminate-environment

説明

指定した環境を終了します。

構文

elastic-beanstalk-terminate-environment [-e [name] | -E [id]] -t

オプション

名前 説明 必須

-e

--environment-name name

終了する環境の名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

条件付き

-E

--environment-id id

終了する環境の ID。

型: 文字列

デフォルト: なし

条件付き

-t

--terminate-resources

環境の終了時に、関連付けられた AWS リソースもシャットダウンするかどうかを指定します。

  • true: 指定した環境と、関連付けられた AWS リソース(Auto Scaling グループや LoadBalance など)の両方が終了されます。

  • false: Elastic Beanstalk のリソース管理は環境から削除されますが、AWS リソースは引き続き機能します。

タイプ: ブール値

有効な値: true | false

デフォルト: true

注記

環境を終了すると、既存の環境だけがリソースを実行することができるため、このパラメータ(-t)は、既存の環境に限って指定することができます。

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – この環境に関連付けられたアプリケーションの名前。

  • CNAME – この環境の CNAME の URL。

  • DateCreated – 環境が作成された日付。

  • DateUpdated – 環境が最後に更新された日付。

  • Description – 環境の説明。

  • EndpointURL – この環境の LoadBalancer の URL。

  • EnvironmentID – この環境の ID。

  • EnvironmentName – この環境の名前。

  • Health – 環境のヘルスステータスの説明。Elastic Beanstalk は実行中の環境のエラーレベルを示します。

    • Red: 環境が応答しないことを示します。1 つの環境について、3 個以上の連続するエラーが発生したときに表示されます。

    • Yellow: 何らかの問題が発生していることを示します。1 つの環境について、2 個以上の連続するエラーが発生したときに表示されます。

    • Green: 環境が正常な状態で、完全に機能していることを示します。

    • Gray: 新しい環境のデフォルトのヘルス。環境は完全に起動していないため、ヘルスチェックがか開始されていないか、UpdateEnvironment または RestartEnvironment リクエスト中でヘルスチェックが一時停止されています。

  • Resources – この環境で使用されている AWS リソースの一覧。

  • SolutionStackName – この環境でデプロイされている SolutionStack の名前。

  • Status – 環境の現在のオペレーションステータス。

    • Launching: 環境は、初期デプロイのプロセス中です。

    • Updating: 環境は、設定またはアプリケーションバージョンを更新するプロセス中です。

    • Ready: 環境は、更新や終了などのアクションを実行できる状態です。

    • Terminating: 環境はシャットダウンプロセス中です。

    • Terminated: 環境は実行中ではありません。

  • TemplateName – この環境の起動に元々使用されていた設定テンプレートの名前。

  • VersionLabel – この環境にデプロイされているアプリケーションバージョン。

環境を終了するには

この例は、環境を終了する方法を示します。


PROMPT> elastic-beanstalk-terminate-environment -e MySampleAppEnv

elastic-beanstalk-update-application

説明

指定したアプリケーションを指定したプロパティに更新します。

注記

プロパティ(description など)が指定されていない場合、値は変わりません。これらのプロパティを消去するには、空の文字列を指定します。

構文

elastic-beanstalk-update-application -a [name] -d [desc]

オプション

名前 説明 必須

-a

--application-name name

更新するアプリケーションの名前。指定したアプリケーションが見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-d

--description desc

アプリケーションの新しい説明。

型: 文字列

デフォルト: 指定しない場合、説明は更新されません。

長さの制限: 最小値は 0 です。最大値は 200 です。

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – アプリケーションの名前。

  • ConfigurationTemplate – このアプリケーションに関連付けられた設定テンプレートの名前。

  • DateCreated – 環境が作成された日付。

  • DateUpdated – 環境が最後に更新された日付。

  • Description – 環境の説明。

  • Versions – このアプリケーションのバージョンの名前。

アプリケーションを更新する

この例は、アプリケーションを更新する方法を示します。


PROMPT> elastic-beanstalk-update-application -a MySampleApp -d "My new description"

elastic-beanstalk-update-application-version

説明

指定したアプリケーションバージョンを指定したプロパティに更新します。

注記

プロパティ(description など)が指定されていない場合、値は変わりません。これらのプロパティを消去するには、空の文字列を指定します。

構文

elastic-beanstalk-update-application-version -a [name] -l [label] -d [desc]

オプション

名前 説明 必須

-a

--application-name name

このバージョンに関連付けられているアプリケーションの名前。指定したアプリケーションが見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-l

--version-label

更新するアプリケーションの名前。

このラベルのアプリケーションバージョンが見つからない場合、InvalidParaemterValue エラーが返されます。

型: 文字列

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-d

--description

リリースの新しい説明。

型: 文字列

デフォルト: 指定しない場合、説明は更新されません。

長さの制限: 最小値は 0 です。最大値は 200 です。

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – このリリースに関連付けられたアプリケーションの名前。

  • DateCreated – アプリケーションバージョンの作成日。

  • DateUpdated – アプリケーションバージョンの最終更新日。

  • Description – このアプリケーションバージョンの説明。

  • SourceBundle – このバージョンのソースバンドルが見つかった場所。

  • VersionLabel – 関連付けられたアプリケーションのバージョンを識別するラベル。

アプリケーションバージョンを更新する

この例は、アプリケーションバージョンを更新する方法を示します。


PROMPT> elastic-beanstalk-update-application-version -a MySampleApp -d "My new version" -l "TestVersion 1"

elastic-beanstalk-update-configuration-template

説明

指定した設定テンプレートを、指定したプロパティまたは設定オプション値に更新します。

注記

プロパティ(ApplicationName など)が指定されていない場合、値は変わりません。これらのプロパティを消去するには、空の文字列を指定します。

構文

elastic-beanstalk-update-configuration-template -a [name] -t [name] -d [desc] -f [filename] -F [filename]

オプション

名前 説明 必須

-a

--application-name name

更新する設定テンプレートに関連付けられているアプリケーションの名前。この名前のアプリケーションが見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-t

--template-name name

更新する設定テンプレートの名前。この名前の設定テンプレートが見つからない場合、UpdateConfigurationTemplate から InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-d

--description desc

設定の新しい説明。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 0 です。最大値は 200 です。

いいえ

-f

--options-file filename

新しく指定したオプション値で更新するオプション設定を含む JSON ファイルの名前。

型: 文字列

いいえ

-F

--options-to-remove-file

削除する設定オプションを含む JSON ファイルの名前。

型: 文字列

デフォルト: なし

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – この設定セットと関連付けられているアプリケーションの名前。

  • DateCreated – この設定セットが作成された日付(UTC 時間)。

  • DateUpdated – この設定セットが最後に変更された日付(UTC 時間)。

  • DeploymentStatus – この設定セットが環境と関連付けられている場合、DeploymentStatus パラメータは、この設定セットの展開ステータスを示します。

    • null: この設定は実行中の環境と関連付けられています。

    • pending: これは、関連付けられた環境にデプロイされておらず、デプロイの処理中であるドラフト設定です。

    • deployed: これは、関連付けられた実行中の環境に現在デプロイされている設定です。

    • failed: これは、正常にデプロイされなかったドラフト設定です。

  • Description – 設定セットの説明。

  • EnvironmentName – null ではない場合、この設定セットの環境の名前。

  • OptionSettings – この設定セットの設定オプションと値の一覧。

  • SolutionStackName – この設定セットが使用するソリューションスタックの名前。

  • TemplateName – null ではない場合、この設定セットの設定テンプレートの名前。

設定テンプレートを更新する

この例は、設定テンプレートを更新する方法を示します。設定の一覧については、「設定オプション」を参照してください。


PROMPT> elastic-beanstalk-update-configuration-template -a MySampleApp -t myconfigtemplate -d "My updated configuration template" -f "options.txt"

options.txt

[
    {
        "Namespace": "aws:elasticbeanstalk:application:environment",
        "OptionName": "my_custom_param_1",
        "Value": "firstvalue"
    },
    {
        "Namespace": "aws:elasticbeanstalk:application:environment",
        "OptionName": "my_custom_param_2",
        "Value": "secondvalue"
    }
]

elastic-beanstalk-update-environment

説明

環境の説明を更新する、新しいアプリケーションバージョンをデプロイする、設定を新規の設定テンプレートに更新する、または実行中の環境で設定オプション値を更新する操作を行います。

リリースと設定の両方を更新する操作は許可されておらず、InvalidParameterCombination エラーが返されます。

設定を新しいテンプレートに更新するか、個々の設定を更新すると、ドラフトの設定が作成され、この環境の DescribeConfigurationSettings によって、DeploymentStatus 値が異なる 2 つの設定の説明が返されます。

構文

elastic-beanstalk-update-environment [-e [name] | -E [id]] -l [label] -t [name] -d [desc] -f [filename] -F [filename]

オプション

名前 説明 必須

-e

--environment-name name

更新する環境の名前。この名前の環境が見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

条件付き

-E

--environment-id id

更新する環境の ID。この ID の環境が存在しない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

条件付き

-l

--version-label >label

このパラメータを指定しない場合、指定したアプリケーションバージョンが環境にデプロイされます。指定したアプリケーションバージョンが見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-t

--template-name name

このパラメータを指定しない場合、この設定テンプレートが環境にデプロイされます。指定した設定テンプレートが見つからない場合、InvalidParameterValue エラーが返されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-d

--description desc

このパラメータを指定した場合、この環境の説明が更新されます。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 0 です。最大値は 200 です。

いいえ

-f

--options-file filename

更新するオプション設定を含むファイル。指定した場合、実行中の環境に関連付けられた設定セットが更新され、指定した設定オプションがリクエストした値に設定されます。

型: 文字列

デフォルト: なし

いいえ

-F

--options-to-remove-file filename

削除するオプション設定を含むファイル。指定した場合、実行中の環境に関連付けられた設定セットからオプション設定が削除されます。

型: 文字列

デフォルト: なし

いいえ

出力

次の情報を含むテーブルが返されます。

  • ApplicationName – この環境に関連付けられたアプリケーションの名前。

  • CNAME – この環境の CNAME の URL。

  • DateCreated – 環境が作成された日付。

  • DateUpdated – 環境が最後に更新された日付。

  • Description – 環境の説明。

  • EndpointURL – この環境の LoadBalancer の URL。

  • EnvironmentID – この環境の ID。

  • EnvironmentName – この環境の名前。

  • Health – 環境のヘルスステータスの説明。Elastic Beanstalk は実行中の環境のエラーレベルを示します。

    • Red: 環境が応答しないことを示します。1 つの環境について、3 個以上の連続するエラーが発生したときに表示されます。

    • Yellow: 何らかの問題が発生していることを示します。1 つの環境について、2 個以上の連続するエラーが発生したときに表示されます。

    • Green: 環境が正常な状態で、完全に機能していることを示します。

    • Gray: 新しい環境のデフォルトのヘルス。環境は完全に起動していないため、ヘルスチェックがか開始されていないか、UpdateEnvironment または RestartEnvironment リクエスト中でヘルスチェックが一時停止されています。

  • Resources – この環境で使用されている AWS リソースの一覧。

  • SolutionStackName – この環境でデプロイされている SolutionStack の名前。

  • Status – 環境の現在のオペレーションステータス。

    • Launching: 環境は、初期デプロイのプロセス中です。

    • Updating: 環境は、設定またはアプリケーションバージョンを更新するプロセス中です。

    • Ready: 環境は、更新や終了などのアクションを実行できる状態です。

    • Terminating: 環境はシャットダウンプロセス中です。

    • Terminated: 環境は実行中ではありません。

  • TemplateName – この環境の起動に元々使用されていた設定テンプレートの名前。

  • VersionLabel – この環境にデプロイされているアプリケーションバージョン。

既存の環境を更新する

この例は、既存の環境を更新する方法を示します。これは、インスタンスのサイズを t1.micro に更新し、2 つの環境変数を設定する options.txt というファイルを渡します。使用できる設定の一覧については、「設定オプション」を参照してください。


PROMPT> elastic-beanstalk-update-environment -e MySampleAppEnv -f "options.txt"

options.txt

[
    {
        "Namespace": "aws:autoscaling:launchconfiguration",
        "OptionName": "InstanceType",
        "Value": "t1.micro"
    },
    {
        "Namespace": "aws:elasticbeanstalk:application:environment",
        "OptionName": "my_custom_param_1",
        "Value": "firstvalue"
    },
    {
        "Namespace": "aws:elasticbeanstalk:application:environment",
        "OptionName": "my_custom_param_2",
        "Value": "secondvalue"
    }
]

elastic-beanstalk-validate-configuration-settings

説明

設定セットと、設定テンプレートまたは環境を使用して、値が有効かどうかを判断します。

このアクションで、オプション値の選択に関連付けられたエラーまたは警告を示すメッセージの一覧が返されます。

構文

elastic-beanstalk-validate-configuration-settings -a [name] -t [name] -e [name] -f [filename]

オプション

名前 説明 必須

-a

--application-name name

設定テンプレートまたは環境が属するアプリケーションの名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

はい

-t

--template-name name

設定を検証する設定テンプレートの名前。

条件: このパラメータと環境名の両方を指定することはできません。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 1 です。最大値は 100 です。

いいえ

-e

--environment-name name

設定を検証する環境の名前。

型: 文字列

デフォルト: なし

長さの制限: 最小値は 4 です。最大値は 23 です。

いいえ

-f

--options-file >filename

評価対象のオプションと望ましい値の一覧を含む JSON ファイルの名前。

型: 文字列

はい

出力

次の情報を含むテーブルが返されます。

  • Message – エラーまたは警告について説明するメッセージ。

  • 名前空間

  • OptionName

  • Severity – このメッセージの重大度。

    • error: このメッセージは、これがオプションの有効な設定ではないことを示します。

    • warning: このメッセージは、考慮する必要がある情報を示します。

環境の設定を検証する

この例は、環境の設定を検証する方法を示します。


PROMPT> elastic-beanstalk-validate-configuration-settings -a MySampleApp -e MySampleAppEnv -f MyOptionSettingsFile.json