AWS OpsWorks スタック CLI の使用

重要

この AWS OpsWorks Stacks サービスは 2024 年 5 月 26 日にサポート終了となり、新規および既存のお客様の両方で無効になっています。できるだけ早くワークロードを他のソリューションに移行することを強くお勧めします。移行についてご質問がある場合は、 AWS re:Post または AWS Premium Support を通じて AWS Support チームにお問い合わせください。

AWS OpsWorks スタックコマンドラインインターフェイス (CLI) は、コンソールと同じ機能を提供し、さまざまなタスクに使用できます。 AWS OpsWorks スタック CLI は の一部です AWS CLI。のインストールと設定方法などの詳細については、「AWS コマンドラインインターフェイスとは AWS CLI」を参照してください。各コマンドの詳細な説明については、「AWS OpsWorks スタックリファレンス」を参照してください。

注記

Windows ベースのワークステーションを使用している場合は、 AWS Tools for Windows を実行して PowerShell 、コマンドラインから AWS OpsWorks スタックオペレーションを実行することもできます。詳細については、「AWS Tools for Windows PowerShell」を参照してください。

AWS OpsWorks スタックコマンドの一般的な形式は次のとおりです。

aws opsworks --region us-west-1 opsworks command-name [--argument1 value] [...]

引数値が JSON オブジェクトである場合は、" 文字をエスケープする必要があります。そうしないと、コマンドから JSON が有効でないというエラーが返されます。例えば、JSON オブジェクトが "{"somekey":"somevalue"}" である場合は、"{\"somekey\":\"somevalue\"}" という形式にします。別のアプローチは、JSON オブジェクトをファイルに保存し、file:// を使用してコマンドラインでそのファイルを指定することです。以下の例では、appsource.json に保存されたアプリケーションソースオブジェクトを使用して、アプリケーションを作成しています。

aws opsworks --region us-west-1 create-app --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8 --name SimpleJSP --type java --app-source file://appsource.json 

ほとんどの場合、コマンドから JSON オブジェクトとしてパッケージ化された 1 つ以上の値が返されます。以下のセクションでは、いくつかの例を示します。各コマンドの戻り値の詳細については、「AWS OpsWorks スタックリファレンス」を参照してください。

注記

AWS CLI コマンドでは、例に示すようにリージョンを指定する必要があります。-- リージョンパラメータの有効値を次の表に示します。 AWS OpsWorks Stacks コマンド文字列を簡素化するには、 --regionパラメータを省略できるように、デフォルトのリージョンを指定するように CLI を設定します。通常、複数のリージョンエンドポイントで作業する場合は、デフォルトのリージョンエンドポイントを使用する AWS CLI ように を設定しないでください。カナダ (中部) リージョンエンドポイントは API および AWS CLI でのみ使用できます。 で作成したスタックでは使用できません AWS Management Console。詳細については、「AWS リージョンの設定」を参照してください。

リージョン名	コマンドコード
米国東部(オハイオ州)リージョン	us-east-2
米国東部（バージニア州北部） リージョン	us-east-1
US West (N. California) リージョン	us-west-1
米国西部 (オレゴン州) リージョン	us-west-2
カナダ (中部) リージョン	ca-central-1
欧州（アイルランド）リージョン	eu-west-1
欧州（ロンドン）リージョン	eu-west-2
欧州（パリ）リージョン	eu-west-3
欧州（フランクフルト）リージョン	eu-central-1
アジアパシフィック (東京) リージョン	ap-northeast-1
アジアパシフィック (ソウル) リージョン	ap-northeast-2
アジアパシフィック (ムンバイ) リージョン	ap-south-1
アジアパシフィック (シンガポール) リージョン	ap-southeast-1
アジアパシフィック (シドニー) リージョン	ap-southeast-2
南米 (サンパウロ) リージョン	sa-east-1

CLI コマンドを使用するには、適切なアクセス許可が必要です。 AWS OpsWorks スタックのアクセス権限の詳細については、「ユーザー許可の管理」を参照してください。特定のコマンドに必要なアクセス許可を調べるには、「AWS OpsWorks スタックリファレンス」のコマンドリファレンスのページを参照してください。

以下のセクションでは、 AWS OpsWorks スタック CLI を使用してさまざまな一般的なタスクを実行する方法について説明します。