

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

# EB CLI コマンドリファレンス
<a name="eb3-cmd-commands"></a>

Elastic Beanstalk コマンドラインインターフェイス (EB CLI) を使用して、Elastic Beanstalk のアプリケーションおよび環境のデプロイと管理を行うためのさまざまなオペレーションを実行できます。Git によってソース管理されるアプリケーションのソースコードをデプロイする場合は、EB CLI が Git と連動します。詳細については、「[Elastic Beanstalk コマンドラインインターフェイス (EB CLI) をセットアップして Elastic Beanstalk を管理する](eb-cli3.md)」および「[Git での EB CLI の使用](eb3-cli-git.md)」を参照してください。

**Topics**
+ [

# 一般的なオプション
](eb3-cmd-options.md)
+ [

# **eb abort**
](eb3-abort.md)
+ [

# **eb appversion**
](eb3-appversion.md)
+ [

# **eb clone**
](eb3-clone.md)
+ [

# **eb codesource**
](eb3-codesource.md)
+ [

# **eb config**
](eb3-config.md)
+ [

# **eb console**
](eb3-console.md)
+ [

# **eb create**
](eb3-create.md)
+ [

# **eb deploy**
](eb3-deploy.md)
+ [

# **eb events**
](eb3-events.md)
+ [

# **eb health**
](eb3-health.md)
+ [

# **eb init**
](eb3-init.md)
+ [

# **eb labs**
](eb3-labs.md)
+ [

# **eb list**
](eb3-list.md)
+ [

# **eb local**
](eb3-local.md)
+ [

# **eb logs**
](eb3-logs.md)
+ [

# **eb migrate**
](eb3-migrate.md)
+ [

# **eb open**
](eb3-open.md)
+ [

# **eb platform**
](eb3-platform.md)
+ [

# **eb printenv**
](eb3-printenv.md)
+ [

# **eb restore**
](eb3-restore.md)
+ [

# **eb scale**
](eb3-scale.md)
+ [

# **eb setenv**
](eb3-setenv.md)
+ [

# **eb ssh**
](eb3-ssh.md)
+ [

# **eb status**
](eb3-status.md)
+ [

# **eb swap**
](eb3-swap.md)
+ [

# **eb tags**
](eb3-tags.md)
+ [

# **eb terminate**
](eb3-terminate.md)
+ [

# **eb upgrade**
](eb3-upgrade.md)
+ [

# **eb use**
](eb3-use.md)

# 一般的なオプション
<a name="eb3-cmd-options"></a>

以下のオプションは、すべての EB CLI コマンドで使用できます。


****  

|  名前  |  説明  | 
| --- | --- | 
|   `--debug`   |  デバッグの情報を出力します。  | 
|   `-h`, `--help`   |  ヘルプメッセージを示します。 型: 文字列 デフォルト: なし  | 
|   `--no-verify-ssl`   |  SSL 証明書認証をスキップします。プロキシで CLI を使用するのに問題がある場合、このオプションを使用します。  | 
|   `--profile`   |   AWS 認証情報ファイルから特定のプロファイルを使用します。  | 
|   `--quiet`   |  コマンドからのすべての出力を非表示にします。  | 
|   `--region`   |  指定されたリージョンを使用します。  | 
|   `-v`, `--verbose`   |  詳細な情報を表示します。  | 

# **eb abort**
<a name="eb3-abort"></a>

## 説明
<a name="eb3-abortdescription"></a>

インスタンスへの環境設定の変更が進行中である場合に、アップグレードをキャンセルします。

**注記**  
更新が進行中の環境が 3 つ以上ある場合は、変更をロールバックする環境名を選択するよう求められます。

## 構文
<a name="eb3-abortsyntax"></a>

 **eb abort** 

 **eb abort *environment-name*** 

## オプション
<a name="eb3-abortoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-abortoutput"></a>

コマンドによって、現在更新中の環境の一覧が表示され、中止する更新を選択するよう求められます。現在更新中の環境が 1 つのみの場合、環境名を指定する必要はありません。成功すると、コマンドは環境設定の変更を戻します。ロールバックプロセスは、環境のすべてのインスタンスに以前の環境設定が戻るか、ロールバックプロセスが失敗するまで続行されます。

## 例
<a name="eb3-abortexample"></a>

次の例では、プラットフォームのアップグレードをキャンセルします。

```
$ eb abort
Aborting update to environment "tmp-dev".
<list of events>
```

# **eb appversion**
<a name="eb3-appversion"></a>

## 説明
<a name="eb3-appversion-description"></a>

EB CLI `appversion` コマンドは、Elastic Beanstalk [アプリケーションのバージョン](concepts.md#concepts-version)を管理します。デプロイせずにアプリケーションの新しいバージョンを作成したり、アプリケーションのバージョンを削除したり、[アプリケーションバージョンのライフサイクルポリシー](applications-lifecycle.md)を作成したりできます。オプションを指定しないでコマンドを呼び出すと、[インタラクティブモード](#eb3-appversion-interactive)になります。

`--create` オプションを使用して、アプリケーションの新しいバージョンを作成します。

`--delete` オプションを使用してアプリケーションのバージョンを削除します。

`lifecycle` オプションを使用してアプリケーションバージョンライフサイクルポリシーを表示または作成します。詳細については、「[アプリケーションバージョンライフサイクルの設定](applications-lifecycle.md)」を参照してください。

## 構文
<a name="eb3-appversion-syntax"></a>

 **eb appversion** 

 **eb appversion [-c \$1 --create]** 

 **eb appversion [-d \$1 --delete] *version-label*** 

 **eb appversion lifecycle [-p \$1 --print]** 

## オプション
<a name="eb3-appversion-options"></a>


****  

|  名前  |  説明 型: 文字列  | 
| --- | --- | 
|  -a *application-name* または --application\$1name *application-name*  | アプリケーションの名前。指定した名前のアプリケーションが見つからない場合、EB CLI によって新しいアプリケーションのアプリケーションバージョンが作成されます。 `--create` オプションでのみ適用できます。 型: 文字列  | 
|  -c または --create  | アプリケーションの[新しいバージョン](concepts.md#concepts-version)を作成します。 | 
|  -d *version-label* または --delete *version-label*  | version-label というラベルの付いたアプリケーションのバージョンを削除します。 | 
|  `-l` *version\$1label* または `--label` *version\$1label*  |  EB CLI で作成するバージョンに使用するラベルを指定します。このオプションを使用しない場合、EB CLI は新しい一意のラベルを生成します。バージョンラベルを指定する場合は、そのラベルが一意であることを確認してください。 `--create` オプションでのみ適用できます。 型: 文字列  | 
|  ライフサイクル  | 新しいアプリケーションバージョンライフサイクルポリシーを作成するには、デフォルトのテキストエディタを呼び出します。このポリシーを使用して、[アプリケーションバージョンクォータ](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html#limits_elastic_beanstalk)に達しないようにします。 | 
|  lifecycle -p または lifecycle --print  | 現行のアプリケーションライフサイクルポリシーを表示します。 | 
|  `-m` "*version\$1description*" または `--message` "*version\$1description*"  |  アプリケーションバージョンの説明。二重引用符で囲まれています。 `--create` オプションでのみ適用できます。 型: 文字列  | 
|  `-p` または `--process`  |  ソースバンドル内の環境マニフェストおよび設定ファイルを事前処理し、検証します。設定ファイルを検証すると、問題を特定できます。アプリケーションバージョンを環境にデプロイする前に、これを実行することをお勧めします。 `--create` オプションでのみ適用できます。  | 
|  `--source codecommit/repository-name/branch-name`  |  CodeCommit リポジトリとブランチ。 `--create` オプションでのみ適用できます。  | 
|  `--staged`  |  HEAD コミットではなく git インデックスでステージングされたファイルを使用して、アプリケーションバージョンを作成します。 `--create` オプションでのみ適用できます。  | 
|  `--timeout` *分*  |  コマンドがタイムアウトするまでの時間（分）。 `--create` オプションでのみ適用できます。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## コマンドのインタラクティブな使用
<a name="eb3-appversion-interactive"></a>

引数なしでコマンドを使用すると、出力にはアプリケーションのバージョンが表示されます。それらは時系列の逆順で一覧表示され、最新のバージョンが最初に表示されています。画面の外観については、[**例**] セクションを参照してください。ステータス行が下部に表示されることに注意してください。ステータス行には、状況依存情報が表示されます。

`d` を押すとアプリケーションバージョンが表示され、`l` を押すとアプリケーションのライフサイクルポリシーを管理でき、`q` を押すと変更を加えずに終了できます。

**注記**  
バージョンが環境にデプロイされた場合、そのバージョンを削除することはできません。

## Output
<a name="eb3-appversion-output"></a>

`--create` オプションを指定してコマンドを実行すると、アプリケーションバージョンが作成されたことを確認するメッセージが表示されます。

`--delete` *version-label* オプションを指定してコマンドを実行すると、アプリケーションバージョンが削除されたことを確認するメッセージが表示されます。

## 例
<a name="eb3-appversion-example"></a>

次の例では、デプロイのないアプリケーション用のインタラクティブなウィンドウを示します。

![\[Application window showing version history with three entries and no current deployment.\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/images/InteractiveModeNoEnvironment.png)


次の例では、アプリケーションのインタラクティブウィンドウが、4 つ目のバージョン (バージョンラベルは [**Sample Application (サンプルアプリケーション)**]) がデプロイされて表示されます。

![\[Application versions table showing 4 versions, with the latest labeled "Sample Application" deployed 2 minutes ago.\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/images/InteractiveModeWithEnvironment.png)


次の例は、**eb appversion lifecycle -p** コマンドの出力を示します。*ACCOUNT-ID* はユーザーのアカウント ID です。

```
Application details for: lifecycle
  Region: sa-east-1
  Description: Application created from the EB CLI using "eb init"
  Date Created: 2016/12/20 02:48 UTC
  Date Updated: 2016/12/20 02:48 UTC
  Application Versions: ['Sample Application']
  Resource Lifecycle Config(s):
    VersionLifecycleConfig:
      MaxCountRule:
        DeleteSourceFromS3: False
        Enabled: False
        MaxCount: 200
      MaxAgeRule:
        DeleteSourceFromS3: False
        Enabled: False
        MaxAgeInDays: 180
    ServiceRole: arn:aws:iam::ACCOUNT-ID:role/aws-elasticbeanstalk-service-role
```

# **eb clone**
<a name="eb3-clone"></a>

## 説明
<a name="eb3-clonedescription"></a>

環境のクローンを新しい環境として作成します。元の環境とクローンされた環境では設定が同じになります。

**注記**  
デフォルトでは、クローンを作成する環境のソリューションスタックのバージョンに関係なく、**eb clone** コマンドは最新のソリューションスタックでクローン環境を作成します。コマンドの実行時に `--exact` オプションを含めることで、これを抑制できます。



**重要**  
クローンの Elastic Beanstalk 環境は、イングレス用のセキュリティグループを引き継ぐのではなく、環境はすべてのインターネットトラフィックに対してオープンのままになります。クローンの環境のイングレスセキュリティグループを再確立する必要があります。  
環境設定のドリフトステータスを確認することで、クローン化できないリソースを確認できます。詳細については、「AWS CloudFormation ユーザーガイド」の「[CloudFormation スタック全体のドリフトを検出する](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/detect-drift-stack.html)」を参照してください 。



## 構文
<a name="eb3-clonesyntax"></a>

 **eb clone** 

 **eb clone *environment-name*** 

## オプション
<a name="eb3-cloneoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-n` *string* または `--clone_name` *string*  |  クローンの環境に指定する名前。  | 
|  `-c` *string* または `--cname` *string*  |  クローンの環境で必要となる CNAME プレフィックス。  | 
|  `--envvars`  |  環境プロパティ。「*name*=*value*」の形式を使用してカンマ区切りリストで指定します。 型: 文字列 制約: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-clone.html)  | 
|  `--exact`  |  Elastic Beanstalk が新しいクローン環境のソリューションスタックのバージョンを使用可能な最新のバージョンに更新することを防止します (元の環境プラットフォーム用)。  | 
|  `--scale` *number*  |  クローンの環境を起動したときにその環境で実行されるインスタンスの数。  | 
|  `--tags` *name*=*value*  |  お客様の環境内のリソースの[タグ](using-features.tagging.md)。*name*=*value* の形式を使用してカンマ区切りリストで指定します。  | 
|  `--timeout`  |  コマンドがタイムアウトするまでの時間（分）。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-cloneoutput"></a>

成功すると、コマンドは元の環境と同じ設定を含む環境、または **eb clone** のオプションで指定された変更が適用された環境を作成します。

## 例
<a name="eb3-cloneexample"></a>

次の例では、指定した環境のクローンが作成されます。

```
$ eb clone
Enter name for Environment Clone
(default is tmp-dev-clone):
Enter DNS CNAME prefix
(default is tmp-dev-clone):
Environment details for: tmp-dev-clone
  Application name: tmp
  Region: us-west-2
  Deployed Version: app-141029_144740
  Environment ID: e-vjvrqnn5pv
  Platform: 64bit Amazon Linux 2014.09 v1.0.9 running PHP 5.5
  Tier: WebServer-Standard-1.0
  CNAME: tmp-dev-clone.elasticbeanstalk.com
  Updated: 2014-10-29 22:00:23.008000+00:00
Printing Status:
2018-07-11 21:04:20    INFO: createEnvironment is starting.
2018-07-11 21:04:21    INFO: Using elasticbeanstalk-us-west-2-888888888888 as Amazon S3 storage bucket for environment data.
...
2018-07-11 21:07:10    INFO: Successfully launched environment: tmp-dev-clone
```

# **eb codesource**
<a name="eb3-codesource"></a>

## 説明
<a name="eb3-codesourcedescription"></a>

EB CLI を設定して CodeCommit リポジトリからデプロイするか、または CodeCommit 統合を無効にし、ローカルマシンからソースバンドルをアップロードします。



**注記**  
一部の AWS リージョンでは CodeCommit が提供されていません。それらのリージョンでは、Elastic Beanstalk と CodeCommit の統合は有効ではありません。  
各リージョンで提供される AWS サービスの詳細については、[「リージョンテーブル](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/)」を参照してください。

## 構文
<a name="eb3-codesourcesyntax"></a>

**eb codesource** 

**eb codesource codecommit**

**eb codesource local**

## オプション
<a name="eb3-codesourceoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-codesourceoutput"></a>

**eb codesource** は、CodeCommit 統合とスタンダードデプロイのどちらかを選択するよう求めます。

**eb codesource codecommit** は、CodeCommit 統合のインタラクティブなリポジトリ設定を開始します。

**eb codesource local** は元の設定を示し、CodeCommit 統合を無効にします。

## 例
<a name="eb3-codesourceexample"></a>

現在のブランチの CodeCommit 統合を設定する場合は、**eb codesource codecommit** を使用します。

```
~/my-app$ eb codesource codecommit
Select a repository
1) my-repo
2) my-app
3) [ Create new Repository ]
(default is 1): 1

Select a branch
1) mainline
2) test
3) [ Create new Branch with local HEAD ]
(default is 1): 1
```

現在のブランチの CodeCommit 統合を無効にする場合は、**eb codesource local** を使用します。

```
~/my-app$ eb codesource local
Current CodeCommit setup:
  Repository: my-app
  Branch: mainline
Default set to use local sources
```

# **eb config**
<a name="eb3-config"></a>

## 説明
<a name="eb3-configdescription"></a>

環境に適用中の[設定](concepts.md#concepts-environmentconfig)と[保存されている環境設定](concepts.md#concepts-configuration)を管理します。このコマンドを使用して、保存されている環境設定をアップロード、ダウンロード、または一覧表示できます。また、適用中の設定のダウンロード、表示、または更新にも使用できます。



root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドは ビルダー設定も変更します。これは、`platform.yaml` で設定された値に基づいて行われます。

**注記**  
**eb config** は、環境プロパティを表示しません。アプリケーションで読み取り可能な環境プロパティを設定するには、代わりに [**eb setenv**](environment-configuration-methods-after.md#configuration-options-after-ebcli-ebsetenv) を使用します。

## 構文
<a name="eb3-configsyntax"></a>

**eb config** コマンドが環境に適用中の[設定](concepts.md#concepts-environmentconfig)を操作するために使用する構文の一部を次に示します。例については、このトピックで後述する「[例](#eb3-configexample)」セクションを参照してください。
+  **eb config** – EDITOR 環境変数として設定したテキストエディタで、環境に適用中の設定を表示します。変更をファイルに保存してエディタを閉じると、ファイルに保存したオプション設定によって環境が更新されます。
**注記**  
EDITOR 環境変数を設定しなかった場合、EB CLI は YAML ファイルのデフォルトエディタにオプション設定を表示します。
+  **eb config *environment-name*** – 名前付き環境の設定を表示および更新します。設定は、設定したテキストエディタまたはデフォルトのエディタの YAML ファイルに表示されます。
+ **eb config save** – 現在の環境に適用中の設定を `.elasticbeanstalk/saved_configs/` というファイル名で `[configuration-name].cfg.yml` に保存します。デフォルトでは、EB CLI は設定を環境名に基いて *configuration-name* という名前で保存します。コマンドの実行時に `--cfg` オプションと必要な設定名を含めることで、別の設定名を指定できます。

  `--tags` オプションを使用して保存された設定にタグを付けることができます。
+ **eb config `--display`** – 環境に適用中の設定をファイルではなく *stdout* に書き込みます。デフォルトでは、これによって端末に設定が表示されます。
+ **eb config `--update configuration_string | file_path`** – 現在の環境に適用されている設定を、*configuration\$1string* または *file\$1path* で識別されるファイル内で指定された情報で更新します。

**注記**  
`--display` オプションおよび `--update` オプションは、環境の設定をプログラム的に読み込んだり改訂したりする柔軟性を備えています。

**eb config** コマンドを使用して[保存した設定](concepts.md#concepts-configuration)を操作するための構文について次に説明します。例については、このトピックで後述する「[例](#eb3-configexample)」セクションを参照してください。
+ **eb config get *config-name*** – Amazon S3 から名前付きで保存された設定をダウンロードします。

  
+ **eb config delete *config-name* ** – Amazon S3 から名前付きで保存された設定を削除します。また、すでにダウンロードしている場合は、ローカルで削除します。
+ **eb config list** – Amazon S3 内に保存した設定を一覧表示します。
+ **eb config put *filename*** – Amazon S3 バケットに名前を付けて保存した設定をアップロードします。*filename* にはファイル拡張子 `.cfg.yml` が必要です。パスを指定せずにファイル名を指定するには、`.elasticbeanstalk` フォルダまたは `.elasticbeanstalk/saved_configs/` フォルダにファイルを保存してからコマンドを実行します。また、「*filename*」にフルパスを指定できます。

## オプション
<a name="eb3-configoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `--cfg config-name`  |  保存した設定に使用する名前。 このオプションは、**eb config save** でのみ使用できます。  | 
|  `-d` または `--display`  |  現在の環境の設定を表示します (*stdout* への書き込み)。 `--format` オプションを使用して、出力が JSON か YAML かを指定します。指定しない場合、出力は YAML 形式になります。 このオプションは、他のサブコマンドなしで **eb config** コマンドを使用する場合にのみ機能します。  | 
|  `-f format_type` または `--format format_type`  |  表示形式を指定します。有効な値は JSON または YAML です。 デフォルトは YAML です。 このオプションは、`--display` オプションでのみ機能します。  | 
|  `-﻿-﻿tags key1=value1[,key2=value2 ...]`  |  保存された設定に追加するタグ。リストでタグを指定するときは、「キー=値」のペアとして指定し、それぞれをカンマで区切ります。 詳細については、「」を参照してください[保存された設定にタグ付けする](environment-configuration-savedconfig-tagging.md) このオプションは、**eb config save** でのみ使用できます。  | 
|  `--timeout timeout`  |  コマンドがタイムアウトするまでの時間（分）。  | 
|  `-u configuration_string \| file_path` または `--update configuration_string \| file_path`  |  現在の環境に適用中の設定を更新します。 このオプションは、他のサブコマンドなしで **eb config** コマンドを使用する場合にのみ機能します。 `configuration_string \| file_path` パラメータは文字列型です。文字列で、環境の設定に対して追加、更新、または削除する名前空間と対応するオプションのリストを指定します。または、入力文字列で、これと同じ情報を含むファイルを表すこともできます。 ファイル名を指定するには、入力文字列が `"file://<path><filename>"` の形式になっている必要があります。`path` なしでファイル名を指定するには、コマンドを実行するフォルダにファイルを保存します。また、フルパスでファイル名を指定することもできます。 設定情報は、次の条件を満たす必要があります。少なくとも 、**OptionSettings** または **OptionsToRemove** のどちらか 1 つのセクションが必要です。**OptionSettings** を使用して、オプションを追加または変更します。**OptionsToRemove** を使用して、名前空間からオプションを削除します。例については、このトピックで後述する「[例](#eb3-configexample)」セクションを参照してください。 

**Example**  
*YAML 形式*  

```
OptionSettings:
  namespace1:
    option-name-1: option-value-1
    option-name-2: option-value-2
    ...
OptionsToRemove:
  namespace1:
    option-name-1
    option-name-2
    ...
``` 

**Example**  
*JSON 形式*  

```
{
   "OptionSettings": {
      "namespace1": {
         "option-name-1": "option-value-1",
         "option-name-2": "option-value-2",
         ...
      }
   },
   "OptionsToRemove": {
      "namespace1": {
         "option-name-1",
         "option-name-2",
         ...
      }
   }
}
```  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-configoutput"></a>

サブコマンドやオプションを追加していない状態で **eb config** または **eb config *environment-name*** コマンドが正常に実行されると、EDITOR 環境変数として設定したテキストエディタに現在のオプション設定が表示されます。EDITOR 環境変数を設定しなかった場合、EB CLI は YAML ファイルのデフォルトエディタにオプション設定を表示します。

変更をファイルに保存してエディタを閉じると、ファイルに保存したオプション設定によって環境が更新されます。次の出力は、設定の更新を確認するために表示されます。

```
$ eb config myApp-dev
    Printing Status:
    2021-05-19 18:09:45    INFO    Environment update is starting.
    2021-05-19 18:09:55    INFO    Updating environment myApp-dev's configuration settings.
    2021-05-19 18:11:20    INFO    Successfully deployed new configuration to environment.
```

`--display` オプションを指定してコマンドが正常に実行されると、現在の環境の設定が表示されます (*stdout* への書き込み)。

`get` パラメータを指定したコマンドの実行に成功すると、コマンドはダウンロードしたローカルコピーの場所を表示します。

`save` パラメータを指定したコマンドの実行に成功すると、コマンドは保存したファイルの場所を表示します。

## 例
<a name="eb3-configexample"></a>

このセクションでは、オプション設定ファイルの表示や編集に使用するテキストエディタを変更する方法を説明します。

Linux および UNIX の場合、次の例では、エディタが vim に変更されます。

```
$ export EDITOR=vim
```

Linux および UNIX の場合、次の例では、エディタが `/usr/bin/kate` にインストールされているエディタに変更されます。

```
$ export EDITOR=/usr/bin/kate
```

次の例では、エディタが Notepad\$1\$1 に変更されます（Windows の場合）。

```
> set EDITOR="C:\Program Files\Notepad++\Notepad++.exe
```

このセクションでは、サブコマンドとともに **eb config** コマンドを実行する場合の例を示します。

以下の例は `app-tmp` という名前の保存された設定を削除します。

```
$ eb config delete app-tmp
```

以下の例は Amazon S3 バケットから app-tmp という名前の保存済み設定をダウンロードします。

```
$ eb config get app-tmp
```

以下の例は Amazon S3 バケットに保存されている保存済み設定の名前を一覧表示します。

```
$ eb config list
```

以下の例は Amazon S3 バケットに app-tmp という名前の保存済み設定のローカルコピーをアップロードします。

```
$ eb config put app-tmp
```

以下の例は現在実行中の環境から設定を保存します。保存した設定に使用する名前を指定しない場合、Elastic Beanstalk は環境名に従って設定ファイルに名前を付けます。例えば、*tmp-dev* という名前の環境は `tmp-dev.cfg.yml` と呼ばれます。Elastic Beanstalk はファイルをフォルダ `/.elasticbeanstalk/saved_configs/` に保存します。

```
$ eb config save
```

以下の例では、`--cfg` オプションを使用して環境 tmp-dev から `v1-app-tmp.cfg.yml` というファイルに設定を保存しています。Elastic Beanstalk はファイルをフォルダ `/.elasticbeanstalk/saved_configs/` に保存します。環境名を指定しない場合、Elastic Beanstalk は現在実行中の環境から設定を保存します。

```
$ eb config save tmp-dev --cfg v1-app-tmp
```

このセクションでは、サブコマンドを使用せずに **eb config** コマンドを実行する場合の例を示します。

次のコマンドは、現在の環境のオプション設定をテキストエディタに表示します。

```
$ eb config
```

次のコマンドは、*my-env* 環境のオプション設定をテキストエディタに表示します。

```
$ eb config my-env
```

次の例では、現在の環境のオプション設定を表示します。`--format` オプションに特定の形式が指定されていないため、YAML 形式で出力されます。

```
$ eb config --display
```

次の例では、現在の環境のオプション設定を、`example.txt` という名前のファイルに指定されているように更新します。ファイルは YAML 形式または JSON 形式のいずれかです。EB CLI はファイル形式を自動的に検出します。
+  名前空間 `aws:autoscaling:asg` の Minsize オプションは 1 に設定されます。
+  名前空間 `aws:elasticbeanstalk:command` のバッチサイズは 30% に設定されます。
+  これにより、名前空間 `AWSEBV2LoadBalancer.aws:elbv2:loadbalancer` から *IdleTimeout: None* のオプション設定が削除されます。

```
$ eb config --update "file://example.txt"
```

**Example - ファイル名: `example.txt` - YAML 形式**  

```
OptionSettings:
  'aws:elasticbeanstalk:command':
    BatchSize: '30'
    BatchSizeType: Percentage
  'aws:autoscaling:asg':
    MinSize: '1'
OptionsToRemove:
  'AWSEBV2LoadBalancer.aws:elbv2:loadbalancer':
    IdleTimeout
```

**Example - ファイル名: `example.txt` - JSON 形式**  

```
{
    "OptionSettings": {
        "aws:elasticbeanstalk:command": {
            "BatchSize": "30",
            "BatchSizeType": "Percentage"
        },
        "aws:autoscaling:asg": {
            "MinSize": "1"
        }
    },
    "OptionsToRemove": {
        "AWSEBV2LoadBalancer.aws:elbv2:loadbalancer": {
            "IdleTimeout"
        }
    }
}
```

次の例では、現在の環境のオプション設定を更新します。このコマンドは、`aws:autoscaling:asg` 名前空間の Minsize オプションを 1 に設定します。

**注記**  
これらの例は、Windows PowerShell に固有のものです。二重引用符 (`"`) 文字の前にスラッシュ (`\`) 文字を付けてエスケープし、二重引用符という文字そのものであることを示します。オペレーティングシステムやコマンドライン環境が異なると、エスケープシーケンスが異なる場合があります。このため、前の例に示した file オプションを使用することをお勧めします。ファイルに設定オプションを指定する場合は、エスケープ文字を必要とせず、異なるオペレーティングシステム間で一貫性があります。

次の例は JSON 形式です。EB CLI は、形式が JSON または YAML のどちらであるかを検出します。

```
PS C:\Users\myUser\EB_apps\myApp-env>eb config --update '{\"OptionSettings\":{\"aws:autoscaling:asg\":{\"MaxSize\":\"1\"}}}'
```

次の例は YAML 形式です。コマンドに YAML ファイルで必要なスペースと行末のリターンが含まれ、YAML 文字列が正しい形式で入力されています。
+ 各行は「Enter」または「Return」キーで終わります。
+ 2 行目を 2 つのスペースで開始し、3 行目を 4 つのスペースで開始します。

```
PS C:\Users\myUser\EB_apps\myApp-env>eb config --update 'OptionSettings:
>>  aws:autoscaling:asg:
>>    MinSize: \"1\"'
```

# **eb console**
<a name="eb3-console"></a>

## 説明
<a name="eb3-consoledescription"></a>

ブラウザを開き、環境設定ダッシュボードを Elastic Beanstalk マネジメントコンソールで表示します。

root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドは Elastic Beanstalk 管理コンソールで `platform.yaml` で指定されているビルダー環境設定も表示します。

## 構文
<a name="eb3-consolesyntax"></a>

 **eb console** 

 **eb console *environment-name*** 

## オプション
<a name="eb3-consoleoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

# **eb create**
<a name="eb3-create"></a>

## 説明
<a name="eb3-createdescription"></a>

新しい環境を作成し、アプリケーションバージョンをデプロイします。

**注記**  
.NET アプリケーションで **eb create** を使用するには、「[.NET アプリケーションのソースバンドルの作成](applications-sourcebundle.md#using-features.deployment.source.dotnet)」を参照してデプロイパッケージを作成し、「[プロジェクトフォルダの代わりにアーティファクトをデプロイする](eb-cli3-configuration.md#eb-cli3-artifact)」を参照してパッケージをアーティファクトとしてデプロイするように CLI 設定をセットアップする必要があります。
EB CLI を使用して環境を作成するには、[サービスロール](concepts-roles-service.md)が必要です。Elastic Beanstalk コンソールで環境を作成することで、サービスロールを作成できます。サービスロールがない場合は、`eb create` を実行すると EB CLI で作成されます。

アプリケーションバージョンは、次のいくつかのソースからデプロイできます。
+ デフォルト: ローカルプロジェクトディレクトリのアプリケーションソースコード。
+ `--version` オプションを使用: アプリケーションに既に存在するアプリケーションバージョン。
+ プロジェクトディレクトリにアプリケーションコードが含まれていない場合、または `--sample` オプションを使用している場合: ご使用環境のプラットフォーム固有のサンプルアプリケーション。

## 構文
<a name="eb3-createsyntax"></a>

**eb create**

**eb create *environment-name***

環境名は 4～40 文字の長さにする必要があります。名前には、英字、数字、ハイフン (-) のみを使用できます。環境名の先頭および末尾にはハイフンを使用できません。

コマンドに環境名を含める場合、EB CLI は選択やサービスロールの作成を要求しません。

環境名引数を指定せずにコマンドを実行すると、インタラクティブなフローで実行され、一部の設定で値の入力または選択が求められます。このインタラクティブなフローで、サンプルアプリケーションをデプロイすると、EB CLI は、このサンプルアプリケーションをローカルプロジェクトディレクトにダウンロードするかどうかを確認します。ダウンロードすると、後で新しい環境で EB CLI を使用して、アプリケーションのコードを必要とするオペレーション (例: [**eb deploy**](eb3-deploy.md)) を実行できます。

一部のインタラクティブなフロープロンプトは、特定の条件でのみ表示されます。例えば、アプリケーションロードバランサーの使用を選択し、アカウントに共有可能な Application Load Balancer が少なくとも 1 つある場合、Elastic Beanstalk は共有ロードバランサーを使用するかどうかを尋ねるプロンプトを表示します。共有可能な Application Load Balancer がアカウントにない場合、このプロンプトは表示されません。

## オプション
<a name="eb3-createoptions"></a>

これらのオプションはいずれも必須ではありません。オプションを指定せずに **eb create** を実行すると、EB CLI より、各設定の値を入力または選択するよう求められます。


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-d` または `--branch_default`  |  現在のリポジトリのデフォルト環境として環境を設定します。  | 
|  `--cfg` *config-name*  |  `.elasticbeanstalk/saved_configs/` または Amazon S3 バケットに保存されている設定から[プラットフォームの設定を使用](environment-configuration-methods-during.md#configuration-options-during-ebcli-savedconfig)します。`.cfg.yml` 拡張子なしで、ファイル名のみを指定します。  | 
|  `-c` *subdomain-name* または `--cname` *subdomain-name*  |  ウェブサイトにルーティングする CNAME DNS エントリの前に付けるサブドメイン名。 型: 文字列 デフォルト: 環境の名前  | 
|  `-db` または `--database`  |  データベースを環境にアタッチします。**eb create** オプションを指定して `--database` を実行するときに、`--database.username` オプションと `--database.password` オプションを指定しないと、EB CLI では、データベースのマスターユーザー名とパスワードを指定するように求められます。  | 
|  `-db.engine` *engine* または `--database.engine` *engine*  |  データベース エンジンのタイプ。このオプションを指定して **eb create** を実行すると、EB CLI はデータベースをアタッチして環境を起動します。これは、`--database` オプションを指定してコマンドを実行しなかった場合でも同様です。 型: 文字列 有効な値: `mysql`, `oracle-se1`, `postgres`, `sqlserver-ex`, `sqlserver-web`, `sqlserver-se`   | 
|  `-db.i` *instance\$1type* または `--database.instance` *instance\$1type*  |  データベースに使用する Amazon EC2 インスタンスのタイプ。このオプションを指定して **eb create** を実行すると、EB CLI はデータベースをアタッチして環境を起動します。これは、`--database` オプションを指定してコマンドを実行しなかった場合でも同様です。 タイプ: 文字列 有効な値: Amazon RDS は DB インスタンスのスタンダードセットをsupport しています。DB エンジンに適切な DB インスタンスを選択するには、いくつかの特定の考慮事項をアカウントに取り入れる必要があります。詳細については、*Amazon RDS ユーザーガイド*の「[DB インスタンスclasses](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)」を参照してください。  | 
|  `-db.pass` *password* または `--database.password` *password*  |  データベースのパスワード。このオプションを指定して **eb create** を実行すると、EB CLI はデータベースをアタッチして環境を起動します。これは、`--database` オプションを指定してコマンドを実行しなかった場合でも同様です。  | 
|  `-db.size` *number\$1of\$1gigabytes* または `--database.size` *number\$1of\$1gigabytes*  |  データベースストレージに割り当てるサイズ（ギガバイト（GB）単位の数値）。このオプションを指定して **eb create** を実行すると、EB CLI はデータベースをアタッチして環境を起動します。これは、`--database` オプションを指定してコマンドを実行しなかった場合でも同様です。 型: 数値 有効な値: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-create.html)  | 
|  `-db.user` *username* または `--database.username` *username*  |  データベースのユーザー名。このオプションを指定して **eb create** を実行すると、`--database` オプションを指定してコマンドを実行しなかった場合でも、EB CLI はデータベースをアタッチして環境を起動します。**eb create** オプションを指定して `--database` を実行するときに、`--database.username` オプションと `--database.password` オプションを指定しないと、EB CLI では、マスターデータベースのユーザー名とパスワードを指定するように求められます。  | 
|  `-db.version` *version* または `--database.version` *バージョン*  |  データベースエンジンのバージョンの指定に使用します。このフラグがある場合、環境は `--database` フラグがなくても、指定したバージョン番号のデータベースを起動します。  | 
|  `--elb-type` *type*  |  [ロードバランサータイプ](using-features.managing.elb.md)。 型: 文字列 有効な値: `classic`, `application`, `network`  デフォルト: `application`  | 
|  `-es` または `--enable-spot`  |  環境のスポットインスタンスリクエストを有効にします。詳細については、「」を参照してください[Auto Scaling グループ](using-features.managing.as.md) 関連オプション: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-create.html)  | 
| --env-group-suffix groupname | 環境の名前に連結するグループ名。[環境を構成する](ebcli-compose.md)のみで使用します。 | 
|  `--envvars`  |  [環境プロパティ](environments-cfg-softwaresettings.md)。「*name*=*value*」の形式を使用してカンマ区切りリストで指定します。制限については、「[環境プロパティ (環境変数) の設定](environments-cfg-softwaresettings.md#environments-cfg-softwaresettings-console)」を参照してください。  | 
|  `-ip` *profile\$1name* または `--instance_profile` *profile\$1name*  |  アプリケーションがリソースにアクセスするために必要な一時的なセキュリティ認証情報を持つ IAM ロールを持つインスタンスプロファイル AWS 。  | 
|  `-it` または `-﻿-﻿instance-types type1[,type2 ...]`  |  環境で使用する Amazon EC2 インスタンスタイプのコンマ区切りリスト。このオプションを指定しない場合、Elastic Beanstalk はデフォルトのインスタンスタイプを提供します。 詳細については、「[Amazon EC2 インスタンス](using-features.managing.ec2.md)」および「[Auto Scaling グループ](using-features.managing.as.md)」を参照してください。  EB CLI は、このオプションをスポットインスタンスにのみ適用します。`--enable-spot` オプションは、このオプションとともに使用されない限り、EB CLI によって無視されます。オンデマンドインスタンスのインスタンスタイプを指定するには、代わりに `--intance-type` (「s」なし) オプションを使用します。   | 
|  `-i` または `--instance_type`  |  環境で使用する Amazon EC2 インスタンスタイプ。このオプションを指定しない場合、Elastic Beanstalk　はデフォルトのインスタンスタイプを提供します。 詳細については、「」を参照してください[Amazon EC2 インスタンス](using-features.managing.ec2.md)  EB CLI は、このオプションをオンデマンドインスタンスにのみ適用します。EB CLI によって無視されるため、このオプションとともに `--enable-spot` オプションを使用しないでください。スポットインスタンスのインスタンスタイプを指定するには、代わりに `--intance-types` (「s」あり) オプションを使用します。   | 
|  `-k` *key\$1name* または `--keyname` *key\$1name*  |  Elastic Beanstalk アプリケーションを実行する Amazon EC2 インスタンスに安全にログインするために、Secure Shell (SSH) クライアントで使用する Amazon EC2 キーペアの名前。**eb create** コマンドでこのオプションを使用すると、指定した値は、**eb init** で指定したキー名を上書きします。 有効な値: Amazon EC2 に登録された既存のキー名  | 
|  `-im` *number-of-instances* または `--min-instances` *number-of-instances*  |  環境に必要な Amazon EC2 インスタンスの最小数。 型: 数値（整数） デフォルト: `1` 有効な値: `1` ～ `10000`  | 
|  `-ix` *number-of-instances* または `--max-instances` *number-of-instances*  |  環境に許可する Amazon EC2 インスタンスの最大数。 型: 数値（整数） デフォルト: `4` 有効な値: `1` ～ `10000`  | 
|  `--modules` *component-a component-b*  | 作成する環境のコンポーネントリスト。[ComposeEnvironments](ebcli-compose.md) でのみ使用します。 | 
|  `-sb` または `--on-demand-base-capacity`  |  環境のスケールアップ時にスポットインスタンスを考慮する前に、Auto Scaling グループがプロビジョニングするオンデマンドインスタンスの最小数。 このオプションは、`--enable-spot` オプションでのみ指定できます。詳細については、「」を参照してください[Auto Scaling グループ](using-features.managing.as.md) 型: 数値（整数） デフォルト: `0` 有効な値: `0`～`--max-instances`（存在しない場合: [`MaxSize`](command-options-general.md#command-options-general-autoscalingasg) 名前空間の `aws:autoscaling:asg` オプション）  | 
|  `-sp` または `--on-demand-above-base-capacity`  |  `--on-demand-base-capacity` オプションで指定されたインスタンス数を超えて Auto Scaling グループがプロビジョニングする追加容量の一部としてのオンデマンドインスタンスの割合。 このオプションは、`--enable-spot` オプションでのみ指定できます。詳細については、「[Auto Scaling グループ](using-features.managing.as.md)」を参照してください。 型: 数値（整数） デフォルト: 単一インスタンス環境では `0`、負荷分散された環境では `70` 有効な値: `0` ～ `100`  | 
|  `-p` *platform-version* または `--platform` *platform-version*  |  使用する[プラットフォームバージョン](concepts.platforms.md)。プラットフォーム、プラットフォームとバージョン、プラットフォームブランチ、ソリューションスタック名、またはソリューションスタック ARN を指定できます。次に例を示します。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-create.html) 利用可能な設定のリストを取得するには、[`eb platform list`](eb3-platform.md) を使用します。 `--platform` を指定した場合は、`eb init` 中に提供された値よりも優先されます。  | 
|  `-pr` または `--process`  |  ソースバンドル内の環境マニフェストおよび設定ファイルを事前処理し、検証します。設定ファイルを検証することで、アプリケーションバージョンを環境にデプロイする前に問題を特定できます。  | 
|  `-r` *region* または `--region` *region*  |  アプリケーションをデプロイする AWS リージョン。 このオプションに指定できる値のリストについては、「AWS 全般のリファレンス」の「[AWS Elastic Beanstalk エンドポイントとクォータ](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html)」を参照してください。  | 
|  `--sample`  |  リポジトリのコードではなく、新しい環境にサンプルアプリケーションをデプロイします。  | 
|  `--scale` *number-of-instances*  |  指定された数のインスタンスで起動します  | 
| --service-role servicerole | デフォルト以外のサービスロールを環境に割り当てます。 ARN を入力しないでください。ロール名のみを入力します。Elastic Beanstalk は、結果の ARN を内部的に作成するために、ロール名の先頭に正しい値を付けます。  | 
|  `-ls` *load-balancer* または `--shared-lb` *load-balancer*  |  共有されたロードバランサーを使用する環境を設定します。アカウント内の共有可能なロードバランサーの名前または ARN を指定します。これは、別の Elastic Beanstalk 環境によって作成されたものではなく、お客様が明示的に作成した Application Load Balancer です。詳細については、「」を参照してください[共有 Application Load Balancer](environments-cfg-alb-shared.md) パラメータの例: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-create.html) このオプションは、`--elb-type application` でのみ指定できます。このオプションを指定し、`--shared-lb` を指定しない場合、Elastic Beanstalk は環境専用のロードバランサーを作成します。  | 
|  `-lp` *port* または `--shared-lb-port` *port*  |  この環境の共有ロードバランサーのデフォルトのリスナーポート。Elastic Beanstalk は、このリスナーからのすべてのトラフィックをデフォルトの環境プロセスにルーティングするリスナールールを追加します。詳細については、「[共有 Application Load Balancer](environments-cfg-alb-shared.md)」を参照してください。 型: 数値（整数） デフォルト: `80` 有効な値: 共有ロードバランサーのリスナーポートを表す任意の整数。  | 
|  `--single`  |  単一の Amazon EC2 インスタンスを使用して環境を作成します。ロードバランサーは使用しません。  シングルインスタンス環境は、本稼働環境では利用できません。インスタンスがデプロイ中に不安定になった場合、または設定の更新中に Elastic Beanstalk がインスタンスを終了して再起動した場合は、アプリケーションを一定期間使用できなくなることがあります。開発、テスト、またはステージングには、単一インスタンス環境を使用します。本稼働用には負荷分散された環境を使用します。   | 
|  `-sm` または `--spot-max-price`  |  お客様がスポットインスタンスに対して支払ってもよいと考えるユニット時間あたりの上限価格 (米ドル)。 このオプションは、`--enable-spot` オプションでのみ指定できます。詳細については、「[Auto Scaling グループ](using-features.managing.as.md)」を参照してください。 タイプ: 数値（浮動小数点） デフォルト: 各インスタンスタイプのオンデマンド料金。この場合のオプションの値は `null` です。 有効な値: `0.001`～`20.0` スポットインスタンスの上限価格オプションに関する推奨事項については、「Amazon EC2 ユーザーガイド」の「[スポットインスタンスの料金履歴](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html)」を参照してください。  | 
|  `-﻿-﻿tags key1=value1[,key2=value2 ...]`  |  環境内のリソースにタグ付けします。タグは、`key=value` ペアのカンマ区切りリストとして指定されます。 詳細については、「[環境のタグ付け](using-features.tagging.md)」を参照してください。  | 
|  `-t worker` または `--tier worker`  | ワーカー環境を作成します。ウェブサーバー環境を作成する場合、このオプションを省略します。 | 
|  `--timeout` *分*  |  コマンドがタイムアウトするまでの時間 (分) を設定します。  | 
|  `--version` *version\$1label*  |  ローカルのプロジェクトディレクトリにあるアプリケーションのソースコードではなく、環境にデプロイするアプリケーションバージョンを指定します。 型: 文字列 有効な値: 既存のアプリケーションバージョンラベル  | 
|  `--vpc`  |  環境に VPC を設定します。このオプションを指定すると、環境を起動する前に、必要なすべての設定を入力するよう求めるプロンプトが EB CLI によって表示されます。  | 
|  `--vpc.dbsubnets subnet1,subnet2`  |  VPC 内のデータベースインスタンスのサブネットを指定します。`--vpc.id` が指定されている場合は必須です。  | 
|  `--vpc.ec2subnets subnet1,subnet2`  |  VPC 内の Amazon EC2 インスタンスのサブネットを指定します。`--vpc.id` が指定されている場合は必須です。  | 
|  `--vpc.elbpublic`  |  VPC のパブリックサブネットで Elastic Load Balancing ロードバランサーを起動します。 このオプションは `--tier worker` または `--single` オプションを使用して指定できません。  | 
|  `--vpc.elbsubnets subnet1,subnet2`  |  VPC 内の Elastic Load Balancing ロードバランサーのサブネットを指定します。 このオプションは `--tier worker` または `--single` オプションを使用して指定できません。  | 
|  `--vpc.id ID`  |  指定した VPC で環境を起動します。  | 
|  `--vpc.publicip`  |  VPC 内のパブリックサブネットで Amazon EC2 インスタンスを起動します。 このオプションは `--tier worker` オプションを使用して指定できません。  | 
|  `--vpc.securitygroups securitygroup1,securitygroup2`  |  セキュリティグループ ID を指定します。`--vpc.id` が指定されている場合は必須です。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-createoutput"></a>

成功すると、コマンドによって質問がいくつか表示され、作成オペレーションのステータスが返されます。起動時に問題があった場合は、[**eb events**](eb3-events.md) オペレーションを使用して詳細を取得できます。

アプリケーションで CodeBuild のサポートを有効にすると、**eb create** でコードの構築時に CodeBuild の情報が表示されます。Elastic Beanstalk での CodeBuild サポートの詳細については、「[での EB CLI の使用 AWS CodeBuild](eb-cli-codebuild.md)」を参照してください。

## 例
<a name="eb3-createexample1"></a>

以下の例では、インタラクティブモードで環境を作成しています。

```
$ eb create
Enter Environment Name
(default is tmp-dev): ENTER
Enter DNS CNAME prefix
(default is tmp-dev): ENTER
Select a load balancer type
1) classic
2) application
3) network
(default is 2): ENTER
Environment details for: tmp-dev
  Application name: tmp
  Region: us-east-2
  Deployed Version: app-141029_145448
  Environment ID: e-um3yfrzq22
  Platform: 64bit Amazon Linux 2014.09 v1.0.9 running PHP 5.5
  Tier: WebServer-Standard-1.0
  CNAME: tmp-dev.elasticbeanstalk.com
  Updated: 2014-10-29 21:54:51.063000+00:00
Printing Status:
...
```

また、以下の例でも、インタラクティブモードで環境を作成しています。この例では、プロジェクトディレクトリにアプリケーションコードはありません。このコマンドはサンプルアプリケーションをデプロイし、ローカルプロジェクトディレクトリにダウンロードします。

```
$ eb create
Enter Environment Name
(default is tmp-dev): ENTER
Enter DNS CNAME prefix
(default is tmp-dev): ENTER
Select a load balancer type
1) classic
2) application
3) network
(default is 2): ENTER
NOTE: The current directory does not contain any source code. Elastic Beanstalk is launching the sample application instead.
Do you want to download the sample application into the current directory?
(Y/n): ENTER
INFO: Downloading sample application to the current directory.
INFO: Download complete.
Environment details for: tmp-dev
  Application name: tmp
  Region: us-east-2
  Deployed Version: Sample Application
  Environment ID: e-um3yfrzq22
  Platform: 64bit Amazon Linux 2014.09 v1.0.9 running PHP 5.5
  Tier: WebServer-Standard-1.0
  CNAME: tmp-dev.elasticbeanstalk.com
  Updated: 2017-11-08 21:54:51.063000+00:00
Printing Status:
...
```

以下のコマンドは、いずれのプロンプトも表示せずに環境を作成します。

```
$ eb create dev-env
Creating application version archive "app-160312_014028".
Uploading test/app-160312_014028.zip to S3. This may take a while.
Upload Complete.
Application test has been created.
Environment details for: dev-env
  Application name: test
  Region: us-east-2
  Deployed Version: app-160312_014028
  Environment ID: e-6fgpkjxyyi
  Platform: 64bit Amazon Linux 2015.09 v2.0.8 running PHP 5.6
  Tier: WebServer-Standard
  CNAME: UNKNOWN
  Updated: 2016-03-12 01:40:33.614000+00:00
Printing Status:
...
```

以下のコマンドは、カスタム VPC に環境を作成します。

```
$ eb create dev-vpc --vpc.id vpc-0ce8dd99 --vpc.elbsubnets subnet-b356d7c6,subnet-02f74b0c --vpc.ec2subnets subnet-0bb7f0cd,subnet-3b6697c1 --vpc.securitygroup sg-70cff265
Creating application version archive "app-160312_014309".
Uploading test/app-160312_014309.zip to S3. This may take a while.
Upload Complete.
Environment details for: dev-vpc
  Application name: test
  Region: us-east-2
  Deployed Version: app-160312_014309
  Environment ID: e-pqkcip3mns
  Platform: 64bit Amazon Linux 2015.09 v2.0.8 running Java 8
  Tier: WebServer-Standard
  CNAME: UNKNOWN
  Updated: 2016-03-12 01:43:14.057000+00:00
Printing Status:
...
```

# **eb deploy**
<a name="eb3-deploy"></a>

## 説明
<a name="eb3-deploydescription"></a>

初期化されたプロジェクトディレクトリから実行アプリケーションにアプリケーションソースバンドルをデプロイします。

git がインストールされている場合、EB CLI は `git archive` コマンドを使用して最新の `.zip` コマンドのコンテンツから `git commit` ファイルを作成します。

ただし、プロジェクトディレクトリに `.ebignore` が存在する場合、EB CLI は git コマンドおよびセマンティクスを使用せずにソースバンドルを作成します。つまり、EB CLI は `.ebignore` で指定されたファイルを無視し、他のすべてのファイルを含めます。特に、コミットされていないソースファイルが含まれます。

**注記**  
プロジェクトフォルダの ZIP ファイルを作成する代わりにビルドプロセスからの中間生成物をデプロイするように EB CLI を設定できます。詳細については、「[プロジェクトフォルダの代わりにアーティファクトをデプロイする](eb-cli3-configuration.md#eb-cli3-artifact)」を参照してください。

## 構文
<a name="eb3-deploysyntax"></a>

 **eb deploy** 

 **eb deploy *environment-name*** 

## オプション
<a name="eb3-deployoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-l` *version\$1label* または `--label` *version\$1label*  |  EB CLI で作成するバージョンに使用するラベルを指定します。ラベルが既に使用されている場合、EB CLI はそのラベルで以前のバージョンを再デプロイします。 型: 文字列  | 
| --env-group-suffix groupname | 環境の名前に連結するグループ名。[環境を構成する](ebcli-compose.md)のみで使用します。 | 
|  `-m` "*version\$1description*" または `--message` "*version\$1description*"  |  アプリケーションバージョンの説明。二重引用符で囲みます。 型: 文字列  | 
|  `--modules` *component-a component-b*  | 更新するコンポーネントのリスト。[環境を構成する](ebcli-compose.md)のみで使用します。 | 
|  `-p` または `--process`  |  ソースバンドル内の環境マニフェストおよび設定ファイルを事前処理し、検証します。設定ファイルを検証することで、アプリケーションバージョンを環境にデプロイする前に問題を特定できます。  | 
|  `--source codecommit/repository-name/branch-name`  |  CodeCommit リポジトリとブランチ。  | 
|  `--staged`  |  HEAD コミットではなく Git インデックスでステージングされたデプロイファイル。  | 
|  `--timeout` *分*  |  コマンドがタイムアウトするまでの時間（分）。  | 
|  `--version` *version\$1label*  |  デプロイする既存のアプリケーションバージョン。 型: 文字列  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-deployoutput"></a>

成功すると、コマンドは `deploy` オペレーションのステータスを返します。

アプリケーションで CodeBuild のサポートを有効にすると、**eb deploy** でコードの構築時に CodeBuild の情報が表示されます。Elastic Beanstalk での CodeBuild サポートの詳細については、「[での EB CLI の使用 AWS CodeBuild](eb-cli-codebuild.md)」を参照してください。

## 例
<a name="eb3-deployexample"></a>

以下の例は、現在のアプリケーションをデプロイします。

```
$ eb deploy
2018-07-11 21:05:22    INFO: Environment update is starting.
2018-07-11 21:05:27    INFO: Deploying new version to instance(s).
2018-07-11 21:05:53    INFO: New application version was deployed to running EC2 instances.
2018-07-11 21:05:53    INFO: Environment update completed successfully.
```

# **eb events**
<a name="eb3-events"></a>

## 説明
<a name="eb3-eventsdescription"></a>

環境の最新のイベントを返します。

root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドでもビルダー環境の最新のイベントを返します。

## 構文
<a name="eb3-eventssyntax"></a>

 **eb events** 

 **eb events *environment-name*** 

## オプション
<a name="eb3-eventsoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-f` または `--follow`  |  イベントをストリーミングします。キャンセルするには、Ctrl\$1C を押します。  | 

## Output
<a name="eb3-eventsoutput"></a>

成功すると、コマンドは最新のイベントを返します。

## 例
<a name="eb3-eventsexample"></a>

以下の例は、最新の 個のイベントを返します。

```
$ eb events
2014-10-29 21:55:39     INFO    createEnvironment is starting.
2014-10-29 21:55:40     INFO    Using elasticbeanstalk-us-west-2-111122223333 as Amazon S3 storage bucket for environment data.
2014-10-29 21:55:57     INFO    Created load balancer named: awseb-e-r-AWSEBLoa-NSKUOK5X6Z9J
2014-10-29 21:56:16     INFO    Created security group named: awseb-e-rxgrhjr9bx-stack-AWSEBSecurityGroup-1UUHU5LZ20ZY7
2014-10-29 21:57:18     INFO    Waiting for EC2 instances to launch. This may take a few minutes.
2014-10-29 21:57:18     INFO    Created Auto Scaling group named: awseb-e-rxgrhjr9bx-stack-AWSEBAutoScalingGroup-1TE320ZCJ9RPD
2014-10-29 21:57:22     INFO    Created Auto Scaling group policy named: arn:aws:autoscaling:us-east-2:11122223333:scalingPolicy:2cced9e6-859b-421a-be63-8ab34771155a:autoScalingGroupName/awseb-e-rxgrhjr9bx-stack-AWSEBAutoScalingGroup-1TE320ZCJ9RPD:policyName/awseb-e-rxgrhjr9bx-stack-AWSEBAutoScalingScaleUpPolicy-1I2ZSNVU4APRY
2014-10-29 21:57:22     INFO    Created Auto Scaling group policy named: arn:aws:autoscaling:us-east-2:11122223333:scalingPolicy:1f08b863-bf65-415a-b584-b7fa3a69a0d5:autoScalingGroupName/awseb-e-rxgrhjr9bx-stack-AWSEBAutoScalingGroup-1TE320ZCJ9RPD:policyName/awseb-e-rxgrhjr9bx-stack-AWSEBAutoScalingScaleDownPolicy-1E3G7PZKZPSOG
2014-10-29 21:57:25     INFO    Created CloudWatch alarm named: awseb-e-rxgrhjr9bx-stack-AWSEBCloudwatchAlarmLow-VF5EJ549FZBL
2014-10-29 21:57:25     INFO    Created CloudWatch alarm named: awseb-e-rxgrhjr9bx-stack-AWSEBCloudwatchAlarmHigh-LA9YEW3O6WJO
2014-10-29 21:58:50     INFO    Added EC2 instance 'i-c7ee492d' to Auto ScalingGroup 'awseb-e-rxgrhjr9bx-stack-AWSEBAutoScalingGroup-1TE320ZCJ9RPD'.
2014-10-29 21:58:53     INFO    Successfully launched environment: tmp-dev
2014-10-29 21:59:14     INFO    Environment health has been set to GREEN
2014-10-29 21:59:43     INFO    Adding instance 'i-c7ee492d' to your environment.
```

# **eb health**
<a name="eb3-health"></a>

## 説明
<a name="eb3-healthdescription"></a>

環境の最新のヘルスステータスを返します。

root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドはビルダー環境の最新のヘルスを返します。

## 構文
<a name="eb3-healthsyntax"></a>

 **eb health** 

 **eb health *environment-name*** 

## オプション
<a name="eb3-healthoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-r` または `--refresh`  |  ヘルス情報を対話モードで表示します。レポートされる情報は 10 秒ごとに更新されます。  | 
| --mono | 出力に色を表示しません。 | 

## Output
<a name="eb3-healthoutput"></a>

成功した場合、コマンドは最新のヘルスステータスを返します。

## 例
<a name="eb3-healthexample"></a>

次の例では、Linux 環境の最新のヘルス情報を返します。

```
~/project $ eb health
 elasticBeanstalkExa-env                                  Ok                       2015-07-08 23:13:20
WebServer                                                                              Ruby 2.1 (Puma)
  total      ok    warning  degraded  severe    info   pending  unknown
    5        5        0        0        0        0        0        0

  instance-id   status     cause                                                                                                health
    Overall     Ok
  i-d581497d    Ok
  i-d481497c    Ok
  i-136e00c0    Ok
  i-126e00c1    Ok
  i-8b2cf575    Ok

  instance-id   r/sec    %2xx   %3xx   %4xx   %5xx      p99      p90      p75     p50     p10                                 requests
    Overall     671.8   100.0    0.0    0.0    0.0    0.003    0.002    0.001   0.001   0.000
  i-d581497d    143.0    1430      0      0      0    0.003    0.002    0.001   0.001   0.000
  i-d481497c    128.8    1288      0      0      0    0.003    0.002    0.001   0.001   0.000
  i-136e00c0    125.4    1254      0      0      0    0.004    0.002    0.001   0.001   0.000
  i-126e00c1    133.4    1334      0      0      0    0.003    0.002    0.001   0.001   0.000
  i-8b2cf575    141.2    1412      0      0      0    0.003    0.002    0.001   0.001   0.000

  instance-id   type       az   running     load 1  load 5      user%  nice%  system%  idle%   iowait%                             cpu
  i-d581497d    t2.micro   1a   12 mins        0.0    0.04        6.2    0.0      1.0   92.5       0.1
  i-d481497c    t2.micro   1a   12 mins       0.01    0.09        5.9    0.0      1.6   92.4       0.1
  i-136e00c0    t2.micro   1b   12 mins       0.15    0.07        5.5    0.0      0.9   93.2       0.0
  i-126e00c1    t2.micro   1b   12 mins       0.17    0.14        5.7    0.0      1.4   92.7       0.1
  i-8b2cf575    t2.micro   1c   1 hour        0.19    0.08        6.5    0.0      1.2   92.1       0.1
  
  instance-id   status     id   version              ago                                                                   deployments
  i-d581497d    Deployed   1    Sample Application   12 mins
  i-d481497c    Deployed   1    Sample Application   12 mins
  i-136e00c0    Deployed   1    Sample Application   12 mins
  i-126e00c1    Deployed   1    Sample Application   12 mins
  i-8b2cf575    Deployed   1    Sample Application   1 hour
```

# **eb init**
<a name="eb3-init"></a>

## 説明
<a name="eb3-initdescription"></a>

一連の質問を表示し、それに応答することによって、EB CLI で作成された Elastic Beanstalk アプリケーションのデフォルト値を設定します。

**注記**  
**eb init** で設定した値は、現在のコンピューター上で現在のディレクトリおよびリポジトリに適用されます。  
コマンドは、アカウントに Elastic Beanstalk アプリケーションを作成します。Elastic Beanstalk 環境を作成するには、**eb init** を実行した後に **[eb create](eb3-create.md)** を実行します。

## 構文
<a name="eb3-initsyntax"></a>

 **eb init** 

 **eb init** *application-name* 

## オプション
<a name="eb3-initoptions"></a>

`--platform` オプションを指定せずに **eb init** を実行すると、EB CLI は各設定の値の入力を求めるプロンプトを表示します。

**注記**  
**eb init** を使用して新しいキーペアを作成するには、`ssh-keygen` がローカルマシンにインストールされており、コマンドラインから呼び出せる必要があります。


****  

|  名前  |  説明  |  | 
| --- | --- | --- | 
|  `-i` `--interactive`  |  すべての **eb init** コマンドオプションの値を指定するように求める指示が、EB CLI で必ず表示されます。  `init` コマンドを使用すると、（デフォルト）値が設定されていない **eb init** コマンドオプションに値を指定するように求められます。ディレクトリで **eb init** コマンドを初めて実行したとき、EB CLI では、コマンドオプションに値を指定するように求められない場合があります。そのような場合は、すでに設定されている内容を変更するために、`--interactive` オプションを使用します。   |  | 
|  `-k` *keyname* `--keyname` *keyname*  |  Elastic Beanstalk アプリケーションを実行する Amazon EC2 インスタンスに安全にログインするために、Secure Shell (SSH) クライアントで使用する Amazon EC2 キーペアの名前。  |  | 
|  `--modules folder-1 folder-2`  |  初期化する子ディレクトリのリスト。[環境を構成する](ebcli-compose.md)のみで使用します。  |  | 
|  `-p` *platform-version*  `--platform` *platform-version*  |  使用する[プラットフォームバージョン](concepts.platforms.md)。プラットフォーム、プラットフォームとバージョン、プラットフォームブランチ、ソリューションスタック名、またはソリューションスタック ARN を指定できます。次に例を示します。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-init.html) 利用可能な設定のリストを取得するには、[`eb platform list`](eb3-platform.md) を使用します。 `--platform` オプションを指定して、インタラクティブ設定をスキップします。  このオプションを使用すると、EB CLI は、他のすべてのオプションについて値の入力を要求しません。ただし、各オプションのデフォルト値の使用が前提となります。デフォルト値を使用しない場合は、そのオプションの値を指定してください。   |  | 
|  `--source codecommit/repository-name/branch-name`  |  CodeCommit リポジトリとブランチ。  |  | 
|  `-﻿-﻿tags key1=value1[,key2=value2 ...]`  |  アプリケーションにタグを付けます。タグは、`key=value` ペアのカンマ区切りリストとして指定されます。 詳細については、「[アプリケーションのタグ付け](applications-tagging.md)」を参照してください。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  |  | 

## CodeBuild サポート
<a name="eb3-init-codebuild"></a>

[buildspec.yml](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html) ファイルを含むフォルダで **eb init** を実行すると、Elastic Beanstalk はファイルを解析して、Elastic Beanstalk に固有のオプションを持つ **eb\$1codebuild\$1settings** エントリを特定します。Elastic Beanstalk での CodeBuild サポートの詳細については、「[での EB CLI の使用 AWS CodeBuild](eb-cli-codebuild.md)」を参照してください。

## Output
<a name="eb3-initoutput"></a>

成功すると、コマンドは一連のプロンプトで新しい Elastic Beanstalk アプリケーションをセットアップする手順を示します。

## 例
<a name="eb3-initexample"></a>

次のリクエストの例は、EB CLI を初期化し、アプリケーションに関する情報を入力するように求めます。*プレースホルダー*テキストを独自の値に置き換えます。

```
$ eb init -i
Select a default region
1) us-east-1 : US East (N. Virginia)
2) us-west-1 : US West (N. California)
3) us-west-2 : US West (Oregon)
4) eu-west-1 : Europe (Ireland)
5) eu-central-1 : Europe (Frankfurt)
6) ap-south-1 : Asia Pacific (Mumbai)
7) ap-southeast-1 : Asia Pacific (Singapore)
...
(default is 3): 3

Select an application to use
1) HelloWorldApp
2) NewApp
3) [ Create new Application ]
(default is 3): 3

Enter Application Name
(default is "tmp"):
Application tmp has been created.

It appears you are using PHP. Is this correct?
(y/n): y

Select a platform branch.
1) PHP 7.2 running on 64bit Amazon Linux
2) PHP 7.1 running on 64bit Amazon Linux (Deprecated)
3) PHP 7.0 running on 64bit Amazon Linux (Deprecated)
4) PHP 5.6 running on 64bit Amazon Linux (Deprecated)
5) PHP 5.5 running on 64bit Amazon Linux (Deprecated)
6) PHP 5.4 running on 64bit Amazon Linux (Deprecated)
(default is 1): 1
Do you want to set up SSH for your instances?
(y/n): y

Select a keypair.
1) aws-eb
2) [ Create new KeyPair ]
(default is 2): 1
```

# **eb labs**
<a name="eb3-labs"></a>

## 説明
<a name="eb3-labsdescription"></a>

**eb labs** サポート作業の進行状況または実験機能のサブコマンド。これらのコマンドは、EB CLI の今後のバージョンで削除されるか改変される場合があり、将来の互換性は保証されません。

使用できるサブコマンドのリストと説明については、**eb labs --help** を実行してください。

# **eb list**
<a name="eb3-list"></a>

## 説明
<a name="eb3-listdescription"></a>

現在のアプリケーションのすべての環境を一覧表示します。`--all` オプションを指定した場合は、すべてのアプリケーションのすべての環境を一覧表示します。

root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドはビルダー環境に関する情報も一覧表示します。

## 構文
<a name="eb3-listsyntax"></a>

 **eb list** 

## オプション
<a name="listoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-a` または `--all`  |  すべてのアプリケーションのすべての環境を一覧表示します。  | 
|  `-v` または `--verbose`  |  インスタンスを含む、すべての環境に関するより詳細な情報を表示します。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-listoutput"></a>

成功すると、コマンドは環境名のリストを返します。現在の環境にはアスタリスク（\$1）が付いています。

## 例 1
<a name="eb3-listexample1"></a>

次の例では、環境名を一覧表示しており、tmp-dev がデフォルトの環境であることを示しています。

```
$ eb list
* tmp-dev
```

## 例 2
<a name="eb3-listexample2"></a>

次の例では、詳細情報を付加して環境を一覧表示しています。

```
$ eb list --verbose
Region: us-west-2
Application: tmp
    Environments: 1
        * tmp-dev : ['i-c7ee492d']
```

# **eb local**
<a name="eb3-local"></a>

## 説明
<a name="eb3-localdescription"></a>

**eb local run** を使用すると、アプリケーションのコンテナが Docker 内のローカルで実行されます。**eb local status** を使用すると、アプリケーションのコンテナのステータスを確認できます。**eb local open** を使用すると、アプリケーションがウェブブラウザで開きます。**eb local logs** を使用すると、アプリケーションのログの場所を取得できます。

**eb local setenv** および **eb local printenv** を使用すると、**eb local run** を使用してローカルで実行した Docker コンテナに渡される環境変数を設定、表示できます。

すべての **eb local** コマンドは、**eb init** を使用して EB CLI リポジトリとして初期化された Docker アプリケーションのプロジェクトディレクトリで実行する必要があります。

**注記**  
Linux または macOS を実行しているローカルコンピュータで **eb local** を使用します。このコマンドでは Windows はサポートされません。  
このコマンドを macOS で使用する前に、Mac 用の Docker をインストールすると共に、boot2docker がインストールされていない (または実行パスに含まれていない) ことを確認してください。**eb local** コマンドは boot2docker (ある場合) を使用しようとしますが、macOS では正常に機能しません。

## 構文
<a name="eb3-localsyntax"></a>

**eb local run**

**eb local status**

**eb local open**

**eb local logs**

**eb local setenv**

**eb local printenv**

## オプション
<a name="eb3-localoptions"></a>

**eb local run**


****  

|  名前  |  説明  | 
| --- | --- | 
|  `--envvars key1=value1,key2=value2`  |  EB CLI がローカルの Docker コンテナに渡す環境変数を設定します。複数コンテナ環境では、すべての変数がすべてのコンテナに渡されます。  | 
|  `--port hostport`  |  ホストのポートをコンテナの公開ポートにマッピングします。このオプションを指定しない場合、EB CLI は、ホストとコンテナの両方で同じポートを使用します。 このオプションは、Docker プラットフォームアプリケーションでのみ機能します。Multicontainer Docker プラットフォームには適用されません。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

**eb local status**

**eb local open**

**eb local logs**

**eb local setenv**

**eb local printenv**

 


****  

|  名前  |  説明  | 
| --- | --- | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-localoutput"></a>

**eb local run**

Docker からのステータスメッセージ。アプリケーションが実行されている間は、アクティブなままです。アプリケーションを停止するには、**Ctrl\$1C** を押します。

**eb local status**

アプリケーションで使用される各コンテナのステータス（実行中かどうか）。

**eb local open**

アプリケーションをウェブブラウザで開き、終了します。

**eb local logs**

**eb local run** を使用してローカルで実行されたアプリケーションによって、プロジェクトディレクトリに生成されるログの場所。

**eb local setenv**

なし

**eb local printenv**

**eb local setenv** を使用して設定された環境変数の名前と値。

## 例
<a name="eb3-localexamples"></a>

**eb local run**

```
~/project$ eb local run
Creating elasticbeanstalk_phpapp_1...
Creating elasticbeanstalk_nginxproxy_1...
Attaching to elasticbeanstalk_phpapp_1, elasticbeanstalk_nginxproxy_1
phpapp_1     | [23-Apr-2015 23:24:25] NOTICE: fpm is running, pid 1
phpapp_1     | [23-Apr-2015 23:24:25] NOTICE: ready to handle connections
```

**eb local status**

ローカルのコンテナのステータスを表示します。

```
~/project$ eb local status
Platform: 64bit Amazon Linux 2014.09 v1.2.1 running Multi-container Docker 1.3.3 (Generic)
Container name: elasticbeanstalk_nginxproxy_1
Container ip: 127.0.0.1
Container running: True
Exposed host port(s): 80
Full local URL(s): 127.0.0.1:80

Container name: elasticbeanstalk_phpapp_1
Container ip: 127.0.0.1
Container running: True
Exposed host port(s): None
Full local URL(s): None
```

**eb local logs**

現在のプロジェクトのログのパスを表示します。

```
~/project$ eb local logs
Elastic Beanstalk will write logs locally to /home/user/project/.elasticbeanstalk/logs/local.
Logs were most recently created 3 minutes ago and written to /home/user/project/.elasticbeanstalk/logs/local/150420_234011665784.
```

**eb local setenv**

**eb local run** とともに使用する環境変数を設定します。

```
~/project$ eb local setenv PARAM1=value
```

**eb local setenv** を使用して設定する環境変数を出力します。

```
~/project$ eb local printenv
Environment Variables:
PARAM1=value
```

# **eb logs**
<a name="eb3-logs"></a>

## 説明
<a name="eb3-logsdescription"></a>

**eb logs** コマンドには、CloudWatch Logs へのログストリーミングを有効または無効にする、インスタンスログまたは CloudWatch Logs ログを取得する、環境の AI を活用した分析をリクエストする 3 つの目的があります。`--cloudwatch-logs` (`-cw`) オプションを使用すると、コマンドはログストリーミングを有効または無効にします。`--analyze` (`-ai`) オプションを使用すると、 コマンドは環境のログ、イベント、インスタンスの状態に関する AI を活用した分析をリクエストします。これらのオプションのいずれかがない場合、ログを取得します。

ログを取得するときは、完全なログを取得する `--all`、`--zip`、または `--stream` オプションを指定します。これらのオプションを指定しない場合は、Elastic Beanstalk は末尾のログを取得します。

コマンドは、指定された環境またはデフォルト環境のログを処理します。関連するログは、コンテナタイプに応じて異なります。root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドはビルダー環境のログも処理します。

詳細については、「[Amazon CloudWatch Logs で Elastic Beanstalk を使用する](AWSHowTo.cloudwatchlogs.md)」を参照してください。AI を活用した分析の詳細については、「」を参照してください[AI を活用した環境分析](health-ai-analysis.md)。

## 構文
<a name="eb3-logssyntax"></a>

 CloudWatch Logs へのログストリーミングを有効または無効にするには: 

```
eb logs --cloudwatch-logs [enable | disable] [--cloudwatch-log-source instance | environment-health | all] [environment-name]
```

 インスタンスログを取得するには: 

```
eb logs [-all | --zip | --stream] [--cloudwatch-log-source instance] [--instance instance-id] [--log-group log-group] [environment-name]
```

 環境のヘルスログを取得するには: 

```
eb logs [-all | --zip | --stream] --cloudwatch-log-source environment-health [environment-name]
```

 AI を活用した分析をリクエストするには: 

```
eb logs --analyze [environment-name]
```

## オプション
<a name="eb3-logsoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-cw [enable \| disable]` または `--cloudwatch-logs [enable \| disable]`  |  CloudWatch Logs へのログストリーミングを有効または無効にします。引数を指定しない場合、ログストリーミングが有効になります。さらに `--cloudwatch-log-source`(`-cls`) オプションが指定されていない場合は、インスタンスのログストリーミングが有効または無効になります。  | 
|  `-cls instance \| environment-health \| all` または `--cloudwatch-log-source instance \| environment-health \| all`  |  CloudWatch Logs を使用しているときにログのソースを指定します。コマンドの有効または無効の形式では、CloudWatch Logs ストリーミングを有効または無効にするログになります。コマンドの検索形式では、これらは CloudWatch Logs から検索するログです。 有効な値: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-logs.html) 値の意味は次のとおりです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-logs.html)  | 
|  `-a` または `--all`  |  すべてのログを取得し、それらのログを `.elasticbeanstalk/logs` ディレクトリに保存します。  | 
|  `-z` または `--zip`  |  すべてのログを取得し、`.zip` ファイルに圧縮して、そのファイルを `.elasticbeanstalk/logs` ディレクトリに保存します。  | 
|  `--stream`  |  完全なログをストリーミングします (継続的な出力)。このオプションを使用すると、コマンドは中断されるまで (**Ctrl\$1C** を押す) 実行を続けます。  | 
|  `-i instance-id` または `--instance instance-id`  |  指定したインスタンスのみのログを取得します。  | 
|  `-g log-group` または `--log-group log-group`  |  ログの取得元となる CloudWatch Logs ロググループを指定します。このオプションは、CloudWatch Logs へのインスタンスログストリーミングが使用可能になっている場合にのみ有効です。 インスタンスログストリーミングが有効になっていて `--log-group` オプションを指定しない場合、デフォルトのロググループは次のいずれかです。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-logs.html) 各ログファイルに対応するロググループの詳細については、「[Elastic Beanstalk が CloudWatch Logs を設定する方法](AWSHowTo.cloudwatchlogs.md#AWSHowTo.cloudwatchlogs.loggroups)」を参照してください。  | 
|  `-ai` または `--analyze`  |  環境のログ、イベント、インスタンスの状態に関する AI を活用した分析をリクエストします。この分析では、Amazon Bedrock を使用して根本原因を特定し、環境のヘルス問題に対する解決策を推奨します。コマンドはリクエストを送信し、分析が完了するまで待機してから結果を表示します。 このオプションは、`--instance`、`--all`、、`--zip`、`--log-group`または と互換性がありません`--cloudwatch-logs`。 前提条件と必要なアクセス許可については、「」を参照してください[AI を活用した環境分析](health-ai-analysis.md)。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-logsoutput"></a>

デフォルトでは、ログはターミナルに直接表示されます。ページングプログラムを使用して出力を表示します。**Q** または **q** を押して終了します。

`--stream` では、ターミナルの既存のログを表示し、実行を続けます。**Ctrl\$1C** を押して終了します。

`--all` と `--zip` を使用して、ログをローカルファイルに保存し、ファイルの場所を表示します。

では`--analyze`、分析が完了すると、AI が生成した分析がターミナルに直接表示されます。

## 例
<a name="logsexample"></a>

次の例では、CloudWatch Logs へのインスタンスログストリーミングを有効にします。

```
$ eb logs -cw enable
Enabling instance log streaming to CloudWatch for your environment
After the environment is updated you can view your logs by following the link:
https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logs:prefix=/aws/elasticbeanstalk/environment-name/
Printing Status:
2018-07-11 21:05:20    INFO: Environment update is starting.
2018-07-11 21:05:27    INFO: Updating environment environment-name's configuration settings.
2018-07-11 21:06:45    INFO: Successfully deployed new configuration to environment.
```

次の例では、インスタンスログを `.zip` ファイルに取得します。

```
$ eb logs --zip
Retrieving logs...
Logs were saved to /home/workspace/environment/.elasticbeanstalk/logs/150622_173444.zip
```

次の例では、環境の AI を活用した分析をリクエストします。

```
$ eb logs --analyze
Analyzing environment...
No critical issues detected. Environment appears healthy.

---
Note: This analysis was generated by AI.
```

# **eb migrate**
<a name="eb3-migrate"></a>

## 説明
<a name="eb3-migratedescription"></a>

Internet Information Services (IIS) サイトとアプリケーションを Windows サーバーから Elastic Beanstalk に移行します。コマンドは、アプリケーションをパッケージ化し、設定を保持し、新しい Elastic Beanstalk 環境にデプロイします。

IIS サイトとアプリケーションの移行の詳細については、「[IIS アプリケーションを Elastic Beanstalk に移行する](dotnet-migrating-applications.md)」を参照してください。

**注記**  
このコマンドを使用する前に、システムが次の要件を満たしていることを確認してください。  
Internet Information Services (IIS) バージョン 7.0 以降
Web Deploy 3.6 以降がインストールされている
Windows サーバーの管理者権限
AWS 適切なアクセス許可で設定された 認証情報
ソースサーバーには、 AWS サービスへのアウトバウンドインターネットアクセスがあります。

以下のステップは、移行プロセスを要約しています。

1. IIS サイトとその設定を検出します。

1. アプリケーションのコンテンツと設定をパッケージ化します。

1. Elastic Beanstalk 環境とアプリケーションを作成します。

1. 保存された設定でアプリケーションをデプロイします。

コマンドは、次のリストに示すように、構造化ディレクトリに移行アーティファクトを作成します。

```
C:\migration_workspace\
└── .\migrations\latest\
    ├── upload_target.zip
    └── upload_target\
        ├── [SiteName].zip                      # One ZIP per default application of IIS site
        ├── [SiteName-ApplicationName].zip      # One ZIP per additional application
        ├── aws-windows-deployment-manifest.json
        └── ebmigrateScripts\
            ├── site_installer.ps1              # Site installation scripts
            ├── permission_handler.ps1          # Permission management
            └── other helper scripts
```

**eb migrate cleanup** を使用して、これらのアーティファクトを管理します。

## 構文
<a name="eb3-migratesyntax"></a>

**eb migrate *[options]***

**eb migrate explore *[options]***

**eb migrate cleanup *[options]***

引数なしで実行すると、**eb migrate** は非インタラクティブモードで動作します。インタラクティブモードで実行するには、**eb migrate --interactive** を実行します。

インタラクティブモードコマンドは、次の情報を求めます。
+ 移行する IIS サイトの選択
+ 環境名とアプリケーション名
+ プラットフォームバージョンの選択
+ インスタンスタイプおよびその他の設定オプション

## サブコマンド
<a name="eb3-migratesubcommands"></a>

### 探索
<a name="eb3-migrateexplore"></a>

**eb migrate explore** サブコマンドは IIS サーバーを調べ、利用可能なサイトを一覧表示します。

このコマンドを使用して、次の情報を表示します。
+ サーバー上のすべての IIS サイトを表示する
+ `--verbose` を使用して、以下を含む詳細な設定を検査します。
  + サイトバインディングとポート
  + アプリケーションプール
  + 仮想ディレクトリとその物理パス
  + 認証設定

```
PS C:\migrations_workspace >  eb migrate explore
Default Web Site
Site2
site3
router
```

```
PS C:\migrations_workspace >  eb migrate explore --verbose
1: Default Web Site:
  - Bindings:
    - *:8083:
  - Application '/':
    - Application Pool: DefaultAppPool
    - Enabled Protocols: http
    - Virtual Directories:
      - /:
        - Physical Path: C:\inetpub\wwwroot
        - Logon Method: ClearText
  - Application '/dotnet-6-0':
    - Application Pool: DefaultAppPool
    - Enabled Protocols: http
    - Virtual Directories:
      - /:
        - Physical Path: C:\inetpub\AspNetCoreWebApps\CoreWebApp-6-0
        - Logon Method: ClearText
  - Application '/dotnet-8-0':
    - Application Pool: DefaultAppPool
    - Enabled Protocols: http
    - Virtual Directories:
      - /:
        - Physical Path: C:\inetpub\AspNetCoreWebApps\CoreWebApp-8-0
        - Logon Method: ClearText
2: Site2:
  - Bindings:
    - *:8081:
...
```

### クリーンアップ
<a name="eb3-migratecleanup"></a>

**eb migrate cleanup** サブコマンドは、次のアクションを使用して移行アーティファクトを管理します。
+ `./migrations/latest` で最後に成功した移行を保持する
+ 古い移行ディレクトリを削除する
+ 重要な設定ファイルを維持する

```
PS C:\migrations_workspace >   eb migrate cleanup
Are you sure you would like to cleanup older artifacts within `./migrations/`? (y/N):
```

`--force` を使用して、クリーンアップ中に確認プロンプトをスキップします。

```
PS C:\migrations_workspace >   eb migrate cleanup --force
```

## オプション
<a name="eb3-migrateoptions"></a>

これらのオプションはいずれも必須ではありません。オプションなしで **eb migrate** を実行すると、EB CLI は非インタラクティブモードで実行されます。**eb migrate --interactive** では、EB CLI により、必要な設定の値を入力または選択するように求められます。


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-a` *application-name* または `--application-name` *application-name*  |  新しい Elastic Beanstalk アプリケーションの名前。 タイプ: 文字列 デフォルト: EBMigratedApp  | 
|  `--archive` *directory-or-zip*  |  **eb migrate --archive-only** によって以前に生成されたソースコードを含むディレクトリまたは ZIP ファイル。 このオプションを使用して、以前に作成した移行パッケージをデプロイします。 例: `--archive .\migrations\latest\upload_target` または `--archive .\migrations\latest\upload_target.zip`  | 
|  `-ao` または `--archive-only`  |  デプロイなしで送信先アーカイブディレクトリのみを作成します。 結果のディレクトリは、`archive` オプションとともに **eb migrate**、または **eb deploy** を使用して手動でデプロイできます。  | 
|  `-c` *subdomain-name* または `--cname` *subdomain-name*  |  移行したアプリケーションの CNAME DNS エントリのプレフィックスとなるサブドメイン名。 タイプ: 文字列 デフォルト: 環境の名前  | 
|  `-cf` または `--copy-firewall-config`  |  アクティブなバインディングを持つすべての HTTP ポートに対して、ソースサーバーのファイアウォール設定を送信先にコピーします。 対応するセキュリティグループルールを作成します AWS。  | 
|  `-es` *snapshot-id* [*snapshot-id* ...] または `--ebs-snapshots` *snapshot-id* [*snapshot-id* ...]  |  環境に関連付ける Amazon EBS スナップショット ID のカンマ区切りリスト。 例: `--ebs-snapshots snap-1234567890abcdef0, snap-0987654321fedcba1`  | 
|  `--encrypt-ebs-volumes`  |  すべての新しい Amazon EBS ボリュームに暗号化を強制します。  これは、すべての今後の Amazon EBS ボリュームの作成に影響するアカウント全体の設定です。   | 
|  `-e` *環境名* または `--environment-name` *環境名*  |  新しい Elastic Beanstalk 環境の名前。 タイプ: 文字列 デフォルト: EBMigratedEnv 制約: 4～40 文字の長さにする必要があります。英字、数字、ハイフンのみを使用できます。ハイフンでスタートまたは終了することはできません。  | 
|  `--force`  |  オペレーション中に確認プロンプトをスキップします。 **cleanup** サブコマンドで使用すると、確認なしで移行アーティファクトを削除します。  | 
|  `-ip` *プロファイル名* または `--instance-profile` *プロファイル名*  |  環境の Amazon EC2 インスタンスに関連付けるインスタンスプロファイル。 指定しない場合、Elastic Beanstalk リソースにアクセスするアクセス許可を持つデフォルトのインスタンスプロファイルを作成します。詳細については、「[Elastic Beanstalk インスタンスプロファイル](concepts-roles-instance.md)」を参照してください。  | 
|  `-i` *インスタンスタイプ* または `--instance-type` *インスタンスタイプ*  |  Elastic Beanstalk 環境に対する Amazon EC2 インスタンスタイプ。 タイプ: 文字列 デフォルト: c5.2xlarge 利用可能なインスタンスタイプについては、「*Amazon EC2 ユーザーガイド*」の「[Amazon EC2 インスタンスタイプ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)」を参照してください。  | 
|  `-in` または `--interactive`  |  移行プロセスの強制インタラクティブモード。 デフォルトが使用可能な場合でも、設定値を求めます。  | 
|  `-k` *key-name* または `--keyname` *key-name*  |  環境インスタンスへの RDP アクセスを有効にする Amazon EC2 キーペア。 ログに表示されないインスタンスレベルの問題の調査に役立ちます。 有効な値: Amazon EC2 に登録された既存のキーペア名  | 
|  `-p` *platform-version* または `--platform` *platform-version*  |  環境の Elastic Beanstalk プラットフォームランタイム。指定しない場合、ホスト Windows Server バージョンから自動的に検出されます。 例: `"64bit Windows Server 2016 v2.16.2 running IIS 10.0"` 使用可能なプラットフォームバージョンのリストについては、[eb platform list](eb3-platform.md#eb3-platform-list) を使用します。  | 
|  `--remote`  |  リモートモードで移行を実行することを示します。このオプションを使用すると、踏み台ホストから実行できます。踏み台ホストは、Elastic Beanstalk に移行されるアプリケーションと設定を含むターゲットサーバーに接続します。踏み台サーバーから実行すると、`eb migrate` は設定を検出し、踏み台ホストで移行ロジックをステージングしてから、アプリケーションを新しい Elastic Beanstalk 環境にデプロイします。 このオプションを使用すると、移行する必要がある Windows サーバーに EB CLI と Python をインストールする必要がなくなります。代わりに踏み台ホストに Python と EB CLI をインストールします。ここでは、**eb migrate** コマンドを `--remote` オプションで実行します。`--target-ip` オプションを使用して、移行する IIS 設定を持つホストを指定します。 `--target-ip`、`--username`、および `--password` とともに使用する必要があります。  | 
|  `--target-ip` *ip-address*  |  移行される IIS サーバーを含むリモート Windows マシンのパブリック IP アドレス。 `--remote` の使用時には必須です。`--remote` を使用する場合にのみ指定できます。  | 
|  `--username` *username*  |  移行する IIS サーバーを含むリモート Windows マシンにアクセスするためのユーザープロファイルのユーザー名。 `--remote` の使用時には必須です。`--remote` を使用する場合にのみ指定できます。  | 
|  `--password` *password*  |  移行する IIS サーバーを含むリモート Windows マシンにアクセスするためのユーザープロファイルのパスワード。 `--remote` の使用時には必須です。`--remote` を使用する場合にのみ指定できます。  | 
|  `-sr` *role-name* または `--service-role` *role-name*  |  Elastic Beanstalk が関連サービスを管理するための IAM AWS サービスロール。 指定しない場合、必要なアクセス許可を持つデフォルトのサービスロールを作成します。詳細については、「[Elastic Beanstalk サービスロール](concepts-roles-service.md)」を参照してください。  完全な ARN ではなく、ロール名のみを指定します。Elastic Beanstalk は完全な ARN を自動的に作成します。   | 
|  `-s` *site-names* または `--sites` *site-names*  |  移行する IIS サイトのカンマ区切りのリスト。指定しない場合、サーバー上の利用可能なすべてのサイトを移行します。 例: `--sites "Default Web Site,Intranet,API"`  | 
|  `--ssl-certificates` *certificate-arn*[,*certificate-arn* ...]  |  Application Load Balancer に関連付ける ACM SSL 証明書 ARN のカンマ区切りのリスト。 HTTPS バインディングを使用してサイトを移行する場合に必要です。 例: `--ssl-certificates arn:aws:acm:region:account:certificate/certificate-id`  | 
|  `-t key1=value1[,key2=value2 ...]` または `-﻿-﻿tags key1=value1[,key2=value2 ...]`  |  環境内の新しいリソースにタグを付けるための `key=value` ペアのカンマ区切りのリスト: 環境、Elastic Beanstalk アプリケーション、アプリケーションバージョン。 詳細については、「[環境のタグ付け](using-features.tagging.md)」を参照してください。  | 
|  `--verbose`  |  移行プロセス中に詳細情報を表示します。 **explore** サブコマンドとともに使用すると、包括的なサイト設定の詳細を表示します。  | 
|  `-vpc` *config-file-or-string* または `--vpc-config` *config-file-or-string*  |  環境の VPC 設定。JSON ファイルパスまたは JSON 文字列として指定します。 設定には以下を含める必要があります。 <pre>{<br />    "id": "vpc-1234567890abcdef0",<br />    "publicip": "true|false",<br />    "elbscheme": "public|private",<br />    "ec2subnets": ["subnet-a1b2c3d4", "subnet-e5f6g7h8"],<br />    "securitygroups": "sg-123456,sg-789012",<br />    "elbsubnets": ["subnet-a1b2c3d4", "subnet-e5f6g7h8"]<br />}</pre> [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-migrate.html)  `--vpc-config` *パラメータ**を指定すると、移行はソース環境からの既存の VPC 設定を無視します*。このパラメータを使用する場合、移行では、渡す設定ファイルで指定された VPC 設定のみを使用します。このパラメータを使用すると、ソースインスタンスの VPC 設定を検出するか、デフォルトの VPC を使用するというデフォルトの動作が上書きされます。   | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-migrateoutput"></a>

コマンドは、移行プロセス全体でステータスの更新を提供します。

1. VPC 設定検出 (EC2 インスタンスで実行されている場合)

1. 各サイトのソースバンドル生成の進行状況

1. 環境の作成ステータス

1. デプロイの進捗状況

成功すると、以下を含む新しい環境の詳細が表示されます。
+ 環境名と ID
+ アプリケーション名
+ リージョン
+ プラットフォームバージョン
+ 環境 CNAME

移行中の問題については、[**eb events**](eb3-events.md) および [**eb health**](eb3-health.md) コマンドを使用して詳細情報を取得します。

## 例
<a name="eb3-migrateexamples"></a>

### 基本的な使用法
<a name="eb3-migrateexamples-basic"></a>

インタラクティブモードでの基本的な移行:

```
PS C:\migrations_workspace >  eb migrate
Identifying VPC configuration of this EC2 instance (i-0123456789abcdef0):
  id: vpc-1234567890abcdef0
  publicip: true
  elbscheme: public
  ec2subnets: subnet-123,subnet-456,subnet-789
  securitygroups: sg-123,sg-456
  elbsubnets: subnet-123,subnet-456,subnet-789

Using .\migrations\latest to contain artifacts for this migration run.
Generating source bundle for sites, applications, and virtual directories...
  Default Web Site/ -> .\migrations\latest\upload_target\DefaultWebSite.zip

Creating application version
Creating environment

Environment details for: EBMigratedEnv
  Application name: EBMigratedApp
  Region: us-west-2
  Deployed Version: app-230320_153045
  Environment ID: e-abcdef1234
  Platform: 64bit Windows Server 2019 v2.7.0 running IIS 10.0
  Tier: WebServer-Standard-1.0
  CNAME: ebmigratedenv.us-west-2.elasticbeanstalk.com
  Updated: 2023-03-20 15:30:45
```

カスタム設定を使用した特定のサイトの移行:

```
PS C:\migrations_workspace >  eb migrate `
    --sites "Default Web Site,InternalAPI" `
    --application-name "CorporateApp" `
    --environment-name "Production" `
    --instance-type "c5.xlarge" `
    --tags "Environment=Production,Team=WebOps" `
    --copy-firewall-config
```

デプロイなしで移行アーカイブの作成:

```
PS C:\migrations_workspace >  eb migrate --archive-only
Using .\migrations\latest to contain artifacts for this migration run.
Generating source bundle for sites, applications, and virtual directories...
  Default Web Site/ -> .\migrations\latest\upload_target\DefaultWebSite.zip

Generated destination archive directory at .\migrations\latest\upload_target
You can execute `eb init` and `eb create` from this directory to deploy to EB.
```

### 高度な設定の例
<a name="eb3-migrateexamples-advanced"></a>

JSON ファイルを使用したカスタム VPC 設定による移行:

```
PS C:\migrations_workspace >  cat vpc-config.json
{
    "id": "vpc-1234567890abcdef0",
    "publicip": "false",
    "elbscheme": "internal",
    "ec2subnets": [
        "subnet-private1",
        "subnet-private2"
    ],
    "securitygroups": [
        "sg-app",
        "sg-database",
        "sg-monitoring"
    ],
    "elbsubnets": [
        "subnet-private1",
        "subnet-private2"
    ]
}

PS C:\migrations_workspace eb migrate `
    --sites "InternalAPI" `
    --vpc-config vpc-config.json `
    --instance-type "r5.xlarge" `
    --tags "Environment=Internal,Security=High"
```

SSL 証明書とホストヘッダーを使用したサイトの移行:

```
PS C:\migrations_workspace >  eb migrate `
    --sites "SecurePortal" `
    --ssl-certificates "arn:aws:acm:region:account:certificate/cert1,arn:aws:acm:region:account:certificate/cert2" `
    --verbose
INFO: Detected HTTPS bindings:
  - www.example.com:443
  - api.example.com:443

INFO: Configuring Application Load Balancer with SSL certificates
INFO: Creating host-based routing rules:
  - www.example.com -> target group 1
  - api.example.com -> target group 2
```

EBS スナップショット設定を使用した移行:

```
PS C:\migrations_workspace >  eb migrate `
    --sites "Default Web Site" `
    --ebs-snapshots "snap-1234567890abcdef0" "snap-0987654321fedcba1" `
    --encrypt-ebs-volumes
Using .\migrations\latest to contain artifacts for this migration run.
INFO: Enabling EBS encryption for all new volumes in us-west-2
INFO: Configuring environment with specified EBS snapshots
```

### セキュリティ設定の例
<a name="eb3-migrateexamples-security"></a>

複雑なファイアウォールルールを使用したサイトの処理:

```
PS C:\migrations_workspace >  eb migrate `
    --sites "Default Web Site,ReportingService" `
    --copy-firewall-config `
    --verbose
INFO: Detected the following Windows Firewall rules:
  - Allow Web Traffic (TCP 80, 443)
  - Allow Reporting Traffic (TCP 8081)
INFO: Creating corresponding security group rules
```

カスタム IAM ロールを使用した移行:

```
PS C:\migrations_workspace >  eb migrate `
    --sites "SecureApp" `
    --instance-profile "CustomInstanceProfile" `
    --service-role "CustomServiceRole"
```

### リモート実行の例
<a name="eb3-migrateexamples-remote"></a>

リモート Windows サーバーからの IIS アプリケーションの移行:

```
PS C:\migrations_workspace >  eb migrate `
    --remote `
    --target-ip "192.0.2.10" `
    --username "administrator" `
    --password "YourPassword123" `
    --application-name "RemoteApp" `
    --environment-name "RemoteEnv"
INFO: Establishing SSH connection to remote host 192.0.2.10...
INFO: Connection established
INFO: Discovering IIS sites on remote host...
INFO: Found 2 sites: Default Web Site, API
INFO: Extracting site configurations...
INFO: Generating source bundle for sites, applications, and virtual directories...
  Default Web Site/ -> .\migrations\latest\upload_target\DefaultWebSite.zip
  API/ -> .\migrations\latest\upload_target\API.zip

Creating application version
Creating environment

Environment details for: RemoteEnv
  Application name: RemoteAppstage mi
  Region: us-west-2
  Deployed Version: app-230320_153045
  Environment ID: e-abcdef1234
  Platform: 64bit Windows Server 2019 v2.7.0 running IIS 10.0
  Tier: WebServer-Standard-1.0
  CNAME: remoteenv.us-west-2.elasticbeanstalk.com
  Updated: 2023-03-20 15:30:45
```

特定のサイト選択によるリモート移行:

```
PS C:\migrations_workspace >  eb migrate `
    --remote `
    --target-ip "192.0.2.10" `
    --username "administrator" `
    --password "YourPassword123" `
    --sites "API" `
    --instance-type "c5.large"
```

# **eb open**
<a name="eb3-open"></a>

## 説明
<a name="eb3-opendescription"></a>

デフォルトのブラウザでウェブサイトのパブリック URL を開きます。

## 構文
<a name="eb3-opensyntax"></a>

 **eb open** 

 **eb open *environment-name*** 

## オプション
<a name="eb3-openoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-openoutput"></a>

コマンド **eb open** では、何も出力されません。代わりに、ブラウザウィンドウでアプリケーションを開きます。

# **eb platform**
<a name="eb3-platform"></a>

## 説明
<a name="eb3-platformdescription"></a>

このコマンドは、2 つの異なるワークスペースをサポートしています。

[プラットフォーム](#eb3-platform-preconfigured)  
このワークスペースを使用して、カスタムプラットフォームを管理します。

[環境](#eb3-platform-environment)  
このワークスペースを使用して、デフォルトのプラットフォームを選択するか、現在のプラットフォームに関する情報を表示します。

Elastic Beanstalk は、**eb platform** のショートカット **ebp** を提供します。

**注記**  
Windows PowerShell では、コマンドエイリアスとして **ebp** を使用します。Windows PowerShell で EB CLI を実行している場合は、このコマンドの長い形式 **eb platform** を使用してください。

## カスタム プラットフォーム用に eb プラットフォームの使用
<a name="eb3-platform-preconfigured"></a>

現在プラットフォームのバージョンを一覧表示し、カスタム プラットフォームを管理することができます。

### 構文
<a name="eb3-platformpresyntax"></a>

**eb platform create [*version*] [*options*]**

**eb platform delete [*version*] [*options*]**

**eb platform events [*version*] [*options*]**

**eb platform init [*platform*] [*options*]**

**eb platform list [*options*]**

**eb platform logs [*version*] [*options*]**

**eb platform status [*version*] [*options*]**

**eb platform use [*platform*] [*options*]**

### オプション
<a name="eb3-platform-options"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `create [version] [options]`  | 新しいプラットフォームバージョンを構築します。[詳細はこちら](#eb3-platform-create)。 | 
|  `delete version [options]`  | プラットフォームバージョンを削除します。[詳細はこちら](#eb3-platform-delete)。 | 
|  `events [version] [options]`  | プラットフォームバージョンからイベントを表示します。[詳細はこちら](#eb3-platform-events)。 | 
|  `init [platform] [options]`  | プラットフォームリポジトリを初期化します。[詳細はこちら](#eb3-platform-init)。 | 
|  `list [options]`  | 現在のプラットフォームのバージョンを一覧表示します。[詳細はこちら](#eb3-platform-list)。 | 
|  `logs [version] [options]`  | プラットフォームバージョンのビルダー環境からログを表示します。[詳細はこちら](#eb3-platform-logs)。 | 
|  `status [version] [options]`  | プラットフォームバージョンのステータスを表示します。[詳細はこちら](#eb3-platform-status)。 | 
|  `use [platform] [options]`  | 新しいバージョンの構築元の別のプラットフォームを選択します。[詳細はこちら](#eb3-platform-use)。 | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

### 一般的なオプション
<a name="eb3-platform-common"></a>

すべての **eb platform** コマンドは、次の一般的なオプションが含まれます。


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-h` または `--help`  |  ヘルプ メッセージと終了を示します。  | 
|  `--debug`  |  追加デバッグ出力を示します。  | 
|  `--quiet`  |  すべての出力を制限します。  | 
|  `-v` または `--verbose`  |  追加の出力を示します。  | 
|  `--profile PROFILE`  |  認証情報から指定の *PROFILE* を使用します。  | 
|  `-r REGION` または `--region REGION`  |  リージョン *REGION* を使用してください。  | 
|  `--no-verify-ssl`  |  SSL AWS 証明書を検証しないでください。  | 

### Eb platform create
<a name="eb3-platform-create"></a>

新しいバージョンのプラットフォームを構築し、新しいバージョンの ARN を返します。現在のリージョンで実行されているビルダー環境がない場合、このコマンドによって環境が起動されます。*バージョン*と増分オプション (`-M`、`-m`、および `-p`) は、相互に排他的です。

#### オプション
<a name="eb3-platform-create-options"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  *version*  |  *バージョン*が指定されていない場合は、パッチバージョン (n.n.N の N) を増分した最新のプラットフォームに基づいて新しいバージョンを作成します。  | 
|  `-M` または `--major-increment`  | メジャーバージョン番号 (n.n.N の N) を増分します。 | 
|  `-m` または `--minor-increment`  | マイナーバージョン番号 (n.n.N の N) を増分します。 | 
|  `-p` または `--patch-increment`  | パッチバージョン番号 (n.n.N の N) を増分します。 | 
|  `-i INSTANCE_TYPE` または --instance-type *INSTANCE\$1TYPE*  | **t1.micro** などのインスタンスタイプとして *INSTANCE\$1TYPE* を使用します。 | 
|  `-ip INSTANCE_PROFILE` または `--instance-profile INSTANCE_PROFILE`  | カスタムプラットフォーム用の AMI を作成する場合は、インスタンスプロファイルとして *INSTANCE\$1PROFILE* を使用します。 `-ip` オプションを指定しない場合は、インスタンスプロファイル `aws-elasticbeanstalk-custom-platforme-ec2-role` を作成して、カスタムプラットフォームで使用します。 | 
|  `-﻿-﻿tags key1=value1[,key2=value2 ...]`  |  タグは、`key=value` ペアのカンマ区切りリストとして指定されます。  | 
|  `--timeout` *分*  |  コマンドがタイムアウトするまでの時間 (分) を設定します。  | 
|  `--vpc.id VPC_ID`  | Packer が構築する VPC の ID。 | 
|  `--vpc.subnets VPC_SUBNETS`  | Packer が構築する VPC のサブネット。 | 
|  `--vpc.publicip`  | パブリック IP を EC2 インスタンスに関連付けます。 | 

### Eb platform delete
<a name="eb3-platform-delete"></a>

プラットフォームバージョンを削除します。環境がそのバージョンを使用している場合、バージョンは削除されません。

#### オプション
<a name="eb3-platform-delete-options"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `version`  | 削除するバージョン。この値は必須です。 | 
|  `--cleanup`  |  `Failed` 状態のすべてのプラットフォームバージョンを削除します。  | 
|  `--all-platforms`  |  `--cleanup` が指定されている場合は、すべてのプラットフォームの `Failed` 状態のすべてのプラットフォームバージョンを削除します。  | 
|  `--force`  |  バージョンを削除するときは確認する必要はありません。  | 

### Eb platform イベント
<a name="eb3-platform-events"></a>

プラットフォームバージョンからイベントを表示します。*バージョン*を指定した場合は、そのバージョンからイベントを表示します。それ以外の場合は、現在のバージョンからイベントを表示します。

#### オプション
<a name="eb3-platform-events-options"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  *version* | イベントが表示されるバージョン。この値は必須です。 | 
|  `-f` または `--follow`  | 発生したイベントを表示し続けます。 | 

### Eb platform init
<a name="eb3-platform-init"></a>

プラットフォームリポジトリを初期化します。

#### オプション
<a name="eb3-platform-init-options"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `platform`  | 初期化するプラットフォームの名前。`-i` (インタラクティブモード) が有効になっていない限り、この値は必須です。 | 
|  `-i` または `--interactive`  |  インタラクティブモードを使用します。  | 
|  `-k KEYNAME` または `--keyname KEYNAME`  |  デフォルトの EC2 キー名。  | 

以前に初期化したディレクトリで実行した場合は workspace のタイプを変更できませんが、以前に初期化したディレクトリではこのコマンドを実行できます。

異なるオプションで初期化を再初期化するには、オプションを `-i` 使用します。

### Eb platform list
<a name="eb3-platform-list"></a>

ワークスペース (ディレクトリ) またはリージョンに関連付けられるプラットフォームのバージョンを一覧表示します。

次のように、コマンドは実行したワークスペースの種類によって異なる結果を返します。
+ プラットフォームワークスペース (`eb platform init` によって初期化されたディレクトリ) では、コマンドはワークスペースで定義されたカスタムプラットフォームのすべてのプラットフォームバージョンのリストを返します。`--all-platforms` または `--verbose` オプションを追加して、アカウントがワークスペースに関連付けられたリージョンにあるすべてのカスタムプラットフォームのすべてのプラットフォームバージョンのリストを取得します。
+ アプリケーションワークスペース (`eb init` で初期化されたディレクトリ) では、このコマンドは、Elastic Beanstalk によって管理されているプラットフォームとアカウントのカスタムプラットフォームの両方について、すべてのプラットフォームバージョンの一覧を返します。このリストには短いプラットフォームバージョン名が使用されており、いくつかのプラットフォームバージョンのバリアントを組み合わせることもできます。`--verbose` オプションを追加すると、フルネームとすべてのバリアントが個別にリストされた詳細リストが表示されます。
+ 初期化されていないディレクトリでは、コマンドは `--region` オプションでのみ機能します。そのリージョンでサポートされているすべての Elastic Beanstalk マネージドプラットフォームバージョンのリストを返します。このリストには短いプラットフォームバージョン名が使用されており、いくつかのプラットフォームバージョンのバリアントを組み合わせることもできます。`--verbose` オプションを追加すると、フルネームとすべてのバリアントが個別にリストされた詳細リストが表示されます。

#### オプション
<a name="eb3-platform-list-options"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-a` または `--all-platforms`  |  初期化されたワークスペース (`eb platform init` または `eb init` によって初期化されたディレクトリ) 内でのみ有効です。アカウントに関連付けられるカスタムプラットフォームすべてのプラットフォームバージョンを一覧表示します。 | 
|  `-s STATUS` または `--status STATUS`  |  *STATUS* と一致するプラットフォームのみを一覧表示します。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/elasticbeanstalk/latest/dg/eb3-platform.html)  | 

### Eb platform logs
<a name="eb3-platform-logs"></a>

プラットフォームバージョンのビルダー環境からログを表示します。

#### オプション
<a name="eb3-platform-logs-options"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `version`  |  ログが表示されるプラットフォームのバージョン。省略した場合、現行バージョンからログを表示します。  | 
|  `--stream`  | CloudWatch でセットアップされたデプロイログをストリーミングします。 | 

### Eb platform status
<a name="eb3-platform-status"></a>

プラットフォームバージョンのステータスを表示します。

#### オプション
<a name="eb3-platform-status-options"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `version`  | ステータスが取得されるプラットフォームのバージョン。省略すると、現在のバージョンのステータスが表示されます。 | 

### Eb platform use
<a name="eb3-platform-use"></a>

新しいバージョンの構築元の別のプラットフォームを選択します。

#### オプション
<a name="eb3-platform-use-options"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `platform`  | このワークスペースのアクティブなバージョンとして*プラットフォーム*を指定します。この値は必須です。 | 

## 環境に eb プラットフォームを使用
<a name="eb3-platform-environment"></a>

サポートされるプラットフォームを示し、環境を起動するときに使用するデフォルトのプラットフォームとプラットフォームバージョンを設定できるようにします。サポートされるすべてのプラットフォームを一覧表示するには、**eb platform list** を使用します。プロジェクトのプラットフォームを変更するには、**eb platform select** を使用します。プロジェクトで選択されたプラットフォームを表示するには、**eb platform show** を使用します。

### 構文
<a name="eb3-platformenvsyntax"></a>

**eb platform list**

**eb platform select**

**eb platform show**

### オプション
<a name="eb3-platformenvoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `list`  | 現在のプラットフォームのバージョンをリストします。 | 
|  `select`  | デフォルトプラットフォームを選択します。 | 
|  `show`  | 現在のプラットフォームに関する情報を示します。 | 

### 例 1
<a name="eb3-platformenvexample1"></a>

次の例では、Elastic Beanstalk がサポートするすべてのプラットフォームのすべての設定のすべての名前を一覧表示しています。

```
$ eb platform list
docker-1.5.0
glassfish-4.0-java-7-(preconfigured-docker)
glassfish-4.1-java-8-(preconfigured-docker)
go-1.3-(preconfigured-docker)
go-1.4-(preconfigured-docker)
iis-7.5
iis-8
iis-8.5
multi-container-docker-1.3.3-(generic)
node.js
php-5.3
php-5.4
php-5.5
python
python-2.7
python-3.4
python-3.4-(preconfigured-docker)
ruby-1.9.3
ruby-2.0-(passenger-standalone)
ruby-2.0-(puma)
ruby-2.1-(passenger-standalone)
ruby-2.1-(puma)
ruby-2.2-(passenger-standalone)
ruby-2.2-(puma)
tomcat-6
tomcat-7
tomcat-7-java-6
tomcat-7-java-7
tomcat-8-java-8
```

### 例 2
<a name="eb3-platformenvexample2"></a>

次の例では、指定したプラットフォームにデプロイするプラットフォームとバージョンの一覧から選択するよう求めます。

```
$ eb platform select
Select a platform.
1) PHP
2) Node.js
3) IIS
4) Tomcat
5) Python
6) Ruby
7) Docker
8) Multi-container Docker
9) GlassFish
10) Go
(default is 1): 5

Select a platform version.
1) Python 2.7
2) Python
3) Python 3.4 (Preconfigured - Docker)
```

### 例 3
<a name="eb3-platformenvexample3"></a>

次の例では、現在のデフォルト プラットフォームに関する情報を示しています。

```
$ eb platform show
Current default platform: Python 2.7
New environments will be running:  64bit Amazon Linux 2014.09 v1.2.0 running Python 2.7

Platform info for environment "tmp-dev":
Current: 64bit Amazon Linux 2014.09 v1.2.0 running Python
Latest:  64bit Amazon Linux 2014.09 v1.2.0 running Python
```

# **eb printenv**
<a name="eb3-printenv"></a>

## 説明
<a name="eb3-printenvdescription"></a>

コマンドウィンドウにすべての環境プロパティを出力します。

## 構文
<a name="eb3-printenvsyntax"></a>

 **eb printenv** 

 **eb printenv *environment-name*** 

## オプション
<a name="eb3-printenvoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-printenvoutput"></a>

成功すると、コマンドは `printenv` オペレーションのステータスを返します。

## 例
<a name="eb3-printenvexample"></a>

以下の例では、特定の環境の環境プロパティを出力します。

```
$ eb printenv
Environment Variables:
     PARAM1 = Value1
```

# **eb restore**
<a name="eb3-restore"></a>

## 説明
<a name="eb3-restoredescription"></a>

終了した環境を再構築し、同じ名前、ID、および設定で新しい環境を作成します。再構築が成功するためには、環境名、ドメイン名、およびアプリケーションバージョンが利用できる必要があります。

## 構文
<a name="eb3-restoresyntax"></a>

 **eb restore** 

 **eb restore *environment\$1id*** 

## オプション
<a name="eb3-restoreoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-restoreoutput"></a>

EB CLI は、復元可能な終了された環境のリストを表示します。

## 例
<a name="eb3-restoreexample"></a>

```
$ eb restore
Select a terminated environment to restore

  #   Name          ID             Application Version      Date Terminated        Ago

  3   gamma         e-s7mimej8e9   app-77e3-161213_211138   2016/12/14 20:32 PST   13 mins
  2   beta          e-sj28uu2wia   app-77e3-161213_211125   2016/12/14 20:32 PST   13 mins
  1   alpha         e-gia8mphu6q   app-77e3-161213_211109   2016/12/14 16:21 PST   4 hours

 (Commands: Quit, Restore, ▼ ▲)

Selected environment alpha
Application:    scorekeep
Description:    Environment created from the EB CLI using "eb create"
CNAME:          alpha.h23tbtbm92.us-east-2.elasticbeanstalk.com
Version:        app-77e3-161213_211109
Platform:       64bit Amazon Linux 2016.03 v2.1.6 running Java 8
Terminated:     2016/12/14 16:21 PST
Restore this environment? [y/n]: y

2018-07-11 21:04:20    INFO: restoreEnvironment is starting.
2018-07-11 21:04:39    INFO: Created security group named: sg-e2443f72
...
```

# **eb scale**
<a name="eb3-scale"></a>

## 説明
<a name="eb3-scaledescription"></a>

インスタンスの最小数と最大数を指定の数に設定し、特定の数のインスタンスで常に動作するように環境をスケーリングします。

## 構文
<a name="eb3-scalesyntax"></a>

 **eb scale *number-of-instances*** 

 **eb scale *number-of-instances* *environment-name*** 

## オプション
<a name="eb3-scaleoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  --timeout  |  コマンドがタイムアウトするまでの時間（分）。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-scaleoutput"></a>

成功すると、コマンドは実行するインスタンスの最小数および最大数を、指定された数に更新します。

## 例
<a name="eb3-scaleexample"></a>

次の例では、インスタンスの数を 2 に設定します。

```
$ eb scale 2
2018-07-11 21:05:22    INFO: Environment update is starting.
2018-07-11 21:05:27    INFO: Updating environment tmp-dev's configuration settings.
2018-07-11 21:08:53    INFO: Added EC2 instance 'i-5fce3d53' to Auto Scaling Group 'awseb-e-2cpfjbra9a-stack-AWSEBAutoScalingGroup-7AXY7U13ZQ6E'.
2018-07-11 21:08:58    INFO: Successfully deployed new configuration to environment.
2018-07-11 21:08:59    INFO: Environment update completed successfully.
```

# **eb setenv**
<a name="eb3-setenv"></a>

## 説明
<a name="eb3-setenv-description"></a>

デフォルトの環境の[環境プロパティ](environments-cfg-softwaresettings.md)を設定します。

## 構文
<a name="eb3-setenv-syntax"></a>

**eb setenv *key*=*value*** 

プロパティは必要な数だけ含めることができますが、すべてプロパティの合計サイズが 4,096 バイトを超えることはできません。値を空白にすると、変数を削除できます。制限については、「[環境プロパティ (環境変数) の設定](environments-cfg-softwaresettings.md#environments-cfg-softwaresettings-console)」を参照してください。

**注記**  
`value` に[特殊文字](http://tldp.org/LDP/abs/html/special-chars.html)が含まれている場合は、これらの文字の先頭に `\` を付けてエスケープする必要があります。

## オプション
<a name="eb3-setenvoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  --timeout  |  コマンドがタイムアウトするまでの時間（分）。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-setenv-output"></a>

成功すると、コマンドは環境が正常に更新されたことを表示します。

## 例
<a name="eb3-setenv-example"></a>

次の例では、環境変数 ExampleVar を設定します。

```
$ eb setenv ExampleVar=ExampleValue
2018-07-11 21:05:25    INFO: Environment update is starting.
2018-07-11 21:05:29    INFO: Updating environment tmp-dev's configuration settings.
2018-07-11 21:06:50    INFO: Successfully deployed new configuration to environment.
2018-07-11 21:06:51    INFO: Environment update completed successfully.
```

以下のコマンドは、複数の環境プロパティを設定します。このコマンドは、`foo` という名前の環境プロパティを追加し、その値を `bar` に設定します。また、`JDBC_CONNECTION_STRING` プロパティの値を変更し、`PARAM4` プロパティと `PARAM5` プロパティを削除します。

```
$ eb setenv foo=bar JDBC_CONNECTION_STRING=hello PARAM4= PARAM5=
```

# **eb ssh**
<a name="eb3-ssh"></a>

## 説明
<a name="eb3-sshdescription"></a>

**注記**  
このコマンドは、Windows Server インスタンスを実行する環境では機能しません。

Secure Shell (SSH) を使用して、環境内の Linux Amazon EC2 インスタンスに接続します。環境で複数のインスタンスが実行されている場合、EB CLI では接続するインスタンスを指定するように求められます。このコマンドを使用するには、SSH がローカルマシンにインストールされており、コマンドラインから呼び出せる必要があります。プライベートキーファイルは、ユーザーディレクトリの下の `.ssh` というフォルダに配置される必要があり、環境の EC2 インスタンスはパブリック IP アドレスを持つ必要があります。

root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドはカスタム環境のインスタンスにも接続します。

 

**SSH キー**  
過去に SSH を設定したことがない場合は、EB CLI を使用して、**eb init** を実行するときにキーを作成できます。すでに **eb init** を実行している場合は、`--interactive` オプションを指定して実行し直し、SSH を設定するプロンプトが表示されたら [**はい**] および [**Create New Keypair (新しいキーペアの作成)**] を選択します。このプロセスで作成されたキーは、EB CLI によって適切なフォルダに保存されます。

環境のセキュリティグループでポート 22 に関するルールが指定されていない場合、このコマンドは、0.0.0.0/0（すべての IP アドレス）からの受信トラフィックについてポート 22 を自動的に開きます。セキュリティを高めるために、制限された CIDR 範囲に対してのみポート 22 を開くよう環境のセキュリティグループを設定してある場合は、EB CLI はその設定を尊重し、セキュリティグループに対するあらゆる変更を破棄します。この動作をオーバーライドし、EB CLI ですべての受信トラフィックに対して強制的にポート 22 を開くには、`--force` オプションを使用します。

環境のセキュリティグループの設定については、「[EC2 セキュリティグループ](using-features.managing.ec2.console.md#using-features.managing.ec2.securitygroups)」を参照してください。

## 構文
<a name="eb3-sshsyntax"></a>

 **eb ssh** 

 **eb ssh *environment-name*** 

## オプション
<a name="eb3-sshoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-i` または `--instance`  |  接続するインスタンスのインスタンス ID を指定します。このオプションを使用することをお勧めします。  | 
|  `-n` または `--number`  |  接続するインスタンスを数値で指定します。  | 
|  `-o` または `--keep_open`  |  SSH セッションの終了後、セキュリティグループでポート 22 を開いたままにします。  | 
|  `--command`  |  SSH セッションを開始する代わりに、指定されたインスタンスでシェルコマンドを実行します。  | 
|  `--custom`  |  'ssh -i keyfile' の代わりに使用する SSH コマンドを指定します。リモートユーザーとホスト名を含めないでください。  | 
|  `--setup`  |  環境のインスタンスに割り当てられているキーペアを変更します (インスタンスを置き換える必要があります)。  | 
|  `--force`  |  環境のセキュリティグループ SSH に関する設定がすでに行われている場合でも、0.0.0.0/0 からの受信トラフィックに対してポート 22 を開きます。 接続しようとしている IP アドレスが含まれない、制限された CIDR 範囲に対してポート 22 を開くように環境のセキュリティグループが設定されている場合に、このオプションを使用します。  | 
|  `--timeout` *分*  |  コマンドがタイムアウトするまでの時間 (分) を設定します。 `--setup` 引数にのみ使用できます。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-sshoutput"></a>

成功すると、コマンドはインスタンスへの SSH 接続を開きます。

## 例
<a name="eb3-sshexample"></a>

次の例では、指定した環境に接続します。

```
$ eb ssh
Select an instance to ssh into
1) i-96133799
2) i-5931e053
(default is 1): 1
INFO: Attempting to open port 22.
INFO: SSH port 22 open.
The authenticity of host '54.191.45.125 (54.191.45.125)' can't be established.
RSA key fingerprint is ee:69:62:df:90:f7:63:af:52:7c:80:60:1b:3b:51:a9.
Are you sure you want to continue connecting (yes/no)? yes
Warning: Permanently added '54.191.45.125' (RSA) to the list of known hosts.

       __|  __|_  )
       _|  (     /   Amazon Linux AMI
      ___|\___|___|

https://aws.amazon.com/amazon-linux-ami/2014.09-release-notes/
No packages needed for security; 1 packages available
Run "sudo yum update" to apply all updates.
[ec2-user@ip-172-31-8-185 ~]$ ls
[ec2-user@ip-172-31-8-185 ~]$ exit
logout
Connection to 54.191.45.125 closed.
INFO: Closed port 22 on ec2 instance security group
```

# **eb status**
<a name="eb3-status"></a>

## 説明
<a name="eb3-status-description"></a>

環境のステータスに関する情報が提供されます。

root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドはビルダー環境に関する情報も表示します。

## 構文
<a name="eb3-status-syntax"></a>

 **eb status** 

 **eb status *environment-name*** 

## オプション
<a name="eb3-statusoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-v` または `--verbose`  |  個々のインスタンスについてより詳細な情報（Elastic Load Balancing ロードバランサーに関するインスタンスのステータスなど）を提供します。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-statusoutput"></a>

成功すると、コマンドは環境に関する次の情報を返します。
+ 環境名
+ アプリケーション名
+ デプロイされたアプリケーションバージョン
+ 環境 ID
+ プラットフォーム
+ 環境枠
+ CNAME
+ 環境が最後に更新された日時
+ ステータス
+ ヘルス

詳細モードを使用すると、EB CLI は、実行中の Amazon EC2 インスタンスの数も表示します。

## 例
<a name="eb3-statusexample"></a>

次の例では、環境 tmp-dev のステータスを示しています。

```
$ eb status
Environment details for: tmp-dev
  Application name: tmp
  Region: us-west-2
  Deployed Version: None
  Environment ID: e-2cpfjbra9a
  Platform: 64bit Amazon Linux 2014.09 v1.0.9 running PHP 5.5
  Tier: WebServer-Standard-1.0
  CNAME: tmp-dev.elasticbeanstalk.com
  Updated: 2014-10-29 21:37:19.050000+00:00
  Status: Launching
  Health: Grey
```

# **eb swap**
<a name="eb3-swap"></a>

## 説明
<a name="eb3-swapdescription"></a>

環境の CNAME を別の環境の CNAME と交換します（たとえば、アプリケーションのバージョンを更新する際にダウンタイムを回避するため）。

**注記**  
2 つ以上の環境がある場合、希望する CNAME を現在使用している環境名を環境リストから選択するよう求められます。これを制限するには、コマンドを実行する際に `-n` オプションで使用する環境の名前を指定します。

## 構文
<a name="eb3-swapsyntax"></a>

 **eb swap** 

 **eb swap *environment-name*** 

**注記**  
*environment-name* は、異なる CNAME を使用する環境です。**eb swap** を実行する際にコマンドラインパラメータに *environment-name* を指定しないと、EB CLI はデフォルトの環境の CNAME を更新します。

## オプション
<a name="eb3-swapoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-n` または `--destination_name`  |  CNAME を交換したい環境の名前を指定します。このオプションを指定しないで **eb swap** を実行すると、EB CLI は環境のリストから選択するよう求められます。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-swapoutput"></a>

成功すると、コマンドは `swap` オペレーションのステータスを返します。

## 例
<a name="eb3-swapexample"></a>

以下の例は環境 tmp-dev を live-env と交換します。

```
$ eb swap
Select an environment to swap with.
1) staging-dev
2) live-env
(default is 1): 2
2018-07-11 21:05:25    INFO: swapEnvironmentCNAMEs is starting.
2018-07-11 21:05:26    INFO: Swapping CNAMEs for environments 'tmp-dev' and 'live-env'.
2018-07-11 21:05:30    INFO: 'tmp-dev.elasticbeanstalk.com' now points to 'awseb-e-j-AWSEBLoa-M7U21VXNLWHN-487871449.us-west-2.elb.amazonaws.com'.
2018-07-11 21:05:30    INFO: Completed swapping CNAMEs for environments 'tmp-dev' and 'live-env'.
```

以下の例は環境 tmp-dev を環境 live-env と交換しますが、設定に値の入力または選択を求めません。

```
$ eb swap tmp-dev --destination_name live-env
2018-07-11 21:18:12    INFO: swapEnvironmentCNAMEs is starting.
2018-07-11 21:18:13    INFO: Swapping CNAMEs for environments 'tmp-dev' and 'live-env'.
2018-07-11 21:18:17    INFO: 'tmp-dev.elasticbeanstalk.com' now points to 'awseb-e-j-AWSEBLoa-M7U21VXNLWHN-487871449.us-west-2.elb.amazonaws.com'.
2018-07-11 21:18:17    INFO: Completed swapping CNAMEs for environments 'tmp-dev' and 'live-env'.
```

# **eb tags**
<a name="eb3-tags"></a>

## 説明
<a name="eb3-tagsdescription"></a>

Elastic Beanstalk リソースのタグを追加、削除、更新、一覧表示します。

Elastic Beanstalk でのリソースへのタグ付けの詳細については、「[Elastic Beanstalk アプリケーションリソースのタグ付け](applications-tagging-resources.md)」を参照してください。

## 構文
<a name="eb3-tagsyntax"></a>

**eb tags [*environment-name*] [--resource *ARN*] -l \$1 --list**

**eb tags [*environment-name*] [--resource *ARN*] -a \$1 --add *key1*=*value1*[,*key2*=*value2* ...]**

**eb tags [*environment-name*] [--resource *ARN*] -u \$1 --update *key1*=*value1*[,*key2*=*value2* ...]**

**eb tags [*environment-name*] [--resource *ARN*] -d \$1 --delete *key1*[,*key2* ...]**

`--add`、`--update`、`--delete` のサブコマンドオプションは、1 つのコマンドで組み合わせることができます。少なくとも 1 つのサブコマンドオプションが必要です。これらの 3 つのサブコマンドオプションを `--list` で組み合わせることはできません。

追加の引数を指定しない場合、これらすべてのコマンドは、現在のディレクトリのアプリケーションでデフォルト環境のタグを一覧表示または変更します。*environment-name* 引数を使用すると、コマンドはその環境のタグを一覧表示または変更します。`--resource` オプションを使用すると、コマンドは任意の Elastic Beanstalk リソース (アプリケーション、環境、アプリケーションバージョン、保存された設定、またはカスタムプラットフォームバージョン) のタグを一覧表示または変更します。リソースを Amazon リソースネーム (ARN) で指定します。

## オプション
<a name="eb3-tagsoptions"></a>

これらのオプションはいずれも必須ではありません。オプションを使用せずに **eb create** を実行すると、各設定の値を入力または選択するよう求められます。


****  

|  名前  |  説明  | 
| --- | --- | 
|  `-l` または `--list`  |  リソースに現在適用されているすべてのタグを一覧表示します。  | 
|  `-﻿a key1=value1[,key2=value2 ...]` または `-﻿-﻿add key1=value1[,key2=value2 ...]`  |  リソースに新しいタグを適用します。`key=value` ペアのカンマ区切りリストとしてタグを指定します。既存のタグのキーを指定することはできません。 有効な値: 「[ リソースのタグ付け](applications-tagging-resources.md)」を参照。  | 
|  `-﻿u key1=value1[,key2=value2 ...]` または `-﻿-﻿update key1=value1[,key2=value2 ...]`  |  既存のリソースタグの値を更新します。`key=value` ペアのカンマ区切りリストとしてタグを指定します。既存のタグのキーを指定する必要があります。 有効な値: 「[ リソースのタグ付け](applications-tagging-resources.md)」を参照。  | 
|  `-﻿d key1[,key2 ...]` または `-﻿-﻿delete key1[,key2 ...]`  |  既存のリソースタグを削除します。キーのカンマ区切りリストとしてタグを指定します。既存のタグのキーを指定する必要があります。 有効な値: 「[ リソースのタグ付け](applications-tagging-resources.md)」を参照。  | 
|  `-r` *region* または `--region` *region*  |  リソースが存在する AWS リージョン 。 デフォルト: 設定されたデフォルトリージョン。 このオプションに指定できる値のリストについては、「AWS 全般のリファレンス」の「[AWS Elastic Beanstalk エンドポイントとクォータ](https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html)」を参照してください。  | 
|  `-﻿-﻿resource ARN`  |  コマンドでタグを変更または一覧表示するリソースの ARN。指定しない場合、コマンドは現在のディレクトリのアプリケーションにおける (デフォルトまたは指定された) 環境を参照します。 有効な値については、該当するリソース別の [ リソースのタグ付け](applications-tagging-resources.md) のサブトピックを参照してください。これらのトピックでは、リソースの ARN の構築方法を示し、該当するリソースの ARN のリストをアプリケーションまたはアカウントで取得する方法について説明しています。  | 

## Output
<a name="eb3-tagsoutput"></a>

`--list` サブコマンドオプションは、リソースのタグを一覧表示します。出力には、Elastic Beanstalk でデフォルトで適用するタグとカスタムタグの両方が表示されます。

```
$ eb tags --list
Showing tags for environment 'MyApp-env':

Key                                 Value

Name                                MyApp-env
elasticbeanstalk:environment-id     e-63cmxwjaut
elasticbeanstalk:environment-name   MyApp-env
mytag                               tagvalue
tag2                                2nd value
```

成功した場合、`--add`、`--update`、`--delete` のサブコマンドオプションには出力されません。コマンドのアクティビティの詳細な出力を表示するには、`--verbose` オプションを追加します。

```
$ eb tags --verbose --update "mytag=tag value"
Updated Tags:

Key                                 Value

mytag                               tag value
```

## 例
<a name="eb3-tagsexamples"></a>

次のコマンドは、キー `tag1` と値 `value1` を使用するタグをアプリケーションのデフォルト環境に正常に追加し、同時にタグ `tag2` を削除します。

```
$ eb tags --add tag1=value1 --delete tag2
```

次のコマンドは、アプリケーション内の保存された設定にタグを正常に追加します。

```
$ eb tags --add tag1=value1 \
      --resource "arn:aws:elasticbeanstalk:us-east-2:my-account-id:configurationtemplate/my-app/my-template"
```

次のコマンドは、存在しないタグを更新しようとしているため失敗します。

```
$ eb tags --update tag3=newval
ERROR: Tags with the following keys can't be updated because they don't exist:

  tag3
```

次のコマンドは、同じキーを更新しようとしているため失敗します。

```
$ eb tags --update mytag=newval --delete mytag
ERROR: A tag with the key 'mytag' is specified for both '--delete' and '--update'. Each tag can be either deleted or updated in a single operation.
```

# **eb terminate**
<a name="eb3-terminate"></a>

## 説明
<a name="eb3-terminatedescription"></a>

実行中の環境を終了して、未使用の AWS リソースに対して料金が発生しないようにします。

[`--all`] オプションを使用して [**eb init**](eb3-init.md) を使って、現在のディレクトリが初期化されたアプリケーションを削除します。このコマンドは、アプリケーション内のすべての環境を終了します。さらに、アプリケーションの[アプリケーションバージョン](applications-versions.md)と[保存された設定](environment-configuration-savedconfig.md)を終了し、アプリケーションを削除します。

root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドは実行中のカスタム環境を終了します。

**注記**  
いつでも、また同じバージョンを使用して新しい環境を起動できます。

保存する必要のある環境のデータがある場合、環境を終了する前にデータベース削除ポリシーを `Retain` に設定します。これにより、データベースは Elastic Beanstalk の外部で動作し続けます。この後、Elastic Beanstalk 環境は外部データベースとして接続する必要があります。データベースを動作させずにデータをバックアップする場合は、環境を終了する前にデータベースのスナップショットを作成するように削除ポリシーを設定します。詳細については、このガイドの*環境の設定*の章で「[データベースのライフサイクル](using-features.managing.db.md#environments-cfg-rds-lifecycle)」を参照してください。

**重要**  
環境を終了する場合は、作成した CNAME マッピングも削除する必要があります。これにより、使用可能になったホスト名を他のお客様が再利用できます。*DNS エントリのダングリング*を防ぐため、終了した環境を指す DNS レコードを必ず削除してください。DNS エントリがダングリングしていると、ユーザーのドメイン宛のインターネットトラフィックがセキュリティの脆弱性にさらされる可能性があります。また、他のリスクをもたらす可能性もあります。  
詳細については、「*Amazon Route 53 デベロッパーガイド*」の「[Route 53 でのダングリング委任レコードからの保護](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/protection-from-dangling-dns.html)」を参照してください。また、ダングリング DNS エントリの詳細については、AWS セキュリティブログの 「[Enhanced Domain Protections for Amazon CloudFront Requests](https://aws.amazon.com/blogs/security/enhanced-domain-protections-for-amazon-cloudfront-requests/)」を参照してください。

## 構文
<a name="eb3-terminatesyntax"></a>

 **eb terminate** 

 **eb terminate *environment-name*** 

## オプション
<a name="eb3-terminateoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `--all`  |  アプリケーションのすべての環境を終了させて、アプリケーションの[アプリケーションバージョン](applications-versions.md)を終了し、[設定を保存](environment-configuration-savedconfig.md)した後で、アプリケーションを削除します。  | 
|  `--force`  |  確認のプロンプトを表示しないで環境を終了します。  | 
|  `--ignore-links`  |  リンクされた依存する環境がある場合でも、環境を終了します。[環境を構成する](ebcli-compose.md) を参照してください。  | 
|  `--timeout`  |  コマンドがタイムアウトするまでの時間（分）。  | 

## Output
<a name="eb3-terminateoutput"></a>

成功すると、コマンドは `terminate` オペレーションのステータスを返します。

## 例
<a name="eb3-terminateexample"></a>

次のサンプルリクエストでは、環境 tmp-dev を終了します。

```
$ eb terminate
The environment "tmp-dev" and all associated instances will be terminated.
To confirm, type the environment name: tmp-dev
2018-07-11 21:05:25    INFO: terminateEnvironment is starting.
2018-07-11 21:05:40    INFO: Deleted CloudWatch alarm named: awseb-e-2cpfjbra9a-stack-AWSEBCloudwatchAlarmHigh-16V08YOF2KQ7U
2018-07-11 21:05:41    INFO: Deleted CloudWatch alarm named: awseb-e-2cpfjbra9a-stack-AWSEBCloudwatchAlarmLow-6ZAWH9F20P7C
2018-07-11 21:06:42    INFO: Deleted Auto Scaling group policy named: arn:aws:autoscaling:us-east-2:11122223333:scalingPolicy:5d7d3e6b-d59b-47c5-b102-3e11fe3047be:autoScalingGroupName/awseb-e-2cpfjbra9a-stack-AWSEBAutoScalingGroup-7AXY7U13ZQ6E:policyName/awseb-e-2cpfjbra9a-stack-AWSEBAutoSca
lingScaleUpPolicy-1876U27JEC34J
2018-07-11 21:06:43    INFO: Deleted Auto Scaling group policy named: arn:aws:autoscaling:us-east-2:11122223333:scalingPolicy:29c6e7c7-7ac8-46fc-91f5-cfabb65b985b:autoScalingGroupName/awseb-e-2cpfjbra9a-stack-AWSEBAutoScalingGroup-7AXY7U13ZQ6E:policyName/awseb-e-2cpfjbra9a-stack-AWSEBAutoSca
lingScaleDownPolicy-SL4LHODMOMU
2018-07-11 21:06:48    INFO: Waiting for EC2 instances to terminate. This may take a few minutes.
2018-07-11 21:08:55    INFO: Deleted Auto Scaling group named: awseb-e-2cpfjbra9a-stack-AWSEBAutoScalingGroup-7AXY7U13ZQ6E
2018-07-11 21:09:10    INFO: Deleted security group named: awseb-e-2cpfjbra9a-stack-AWSEBSecurityGroup-XT4YYGFL7I99
2018-07-11 21:09:40    INFO: Deleted load balancer named: awseb-e-2-AWSEBLoa-AK6RRYFQVV3S
2018-07-11 21:09:42    INFO: Deleting SNS topic for environment tmp-dev.
2018-07-11 21:09:52    INFO: terminateEnvironment completed successfully.
```

# **eb upgrade**
<a name="eb3-upgrade"></a>

## 説明
<a name="eb3-upgradedescription"></a>

現在実行中のプラットフォームの最新バージョンに環境のプラットフォームをアップグレードします。

root ディレクトリにカスタムプラットフォームを指定する `platform.yaml` ファイルが含まれている場合、このコマンドは、現在実行しているカスタムプラットフォームの最新バージョンに環境をアップグレードします。

## 構文
<a name="eb3-upgradesyntax"></a>

 **eb upgrade** 

 **eb upgrade *environment-name*** 

## オプション
<a name="eb3-upgradeoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `--force`  |  アップグレード処理を開始する前に環境名の確認を必要とすることなく、アップグレードを実行します。  | 
|  `--noroll`  |  アップグレード中に実行中の一部のインスタンスを維持するため、ローリング更新を使用せずにすべてのインスタンスを更新します。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 

## Output
<a name="eb3-upgradeoutput"></a>

このコマンドは変更の概要を示し、環境名を入力することにより、アップグレードの確認を求めます。成功すると、環境はアップグレードされてから、プラットフォームの最新バージョンで起動されます。

## 例
<a name="eb3-upgradeexample"></a>

次の例では、指定した環境の現在プラットフォームバージョンを使用可能な最新のプラットフォームバージョンにアップグレードします。

```
$ eb upgrade
Current platform: 64bit Amazon Linux 2014.09 v1.0.9 running Python 2.7
Latest platform:  64bit Amazon Linux 2014.09 v1.2.0 running Python 2.7

WARNING: This operation replaces your instances with minimal or zero downtime. You may cancel the upgrade after it has started by typing "eb abort".
You can also change your platform version by typing "eb clone" and then "eb swap".

To continue, type the environment name:
```

# **eb use**
<a name="eb3-use"></a>

## 説明
<a name="eb3-usedescription"></a>

指定した環境をデフォルトの環境として設定します。

Git を使用するときに、**eb use** は現在のブランチのデフォルト環境を設定します。Elastic Beanstalk にデプロイする各ブランチで、このコマンドを 1 回実行します。

## 構文
<a name="eb3-usesyntax"></a>

 **eb use *environment-name*** 

## オプション
<a name="eb3-useoptions"></a>


****  

|  名前  |  説明  | 
| --- | --- | 
|  `--source codecommit/repository-name/branch-name`  |  CodeCommit リポジトリとブランチ。  | 
|  `-r region` `--region region`  |  環境を作成するリージョンを変更します。  | 
|  [一般的なオプション](eb3-cmd-options.md)  |  | 