タダです.

「AWS Copilot CLI」のコマンドとそのパラメーターでまだまだ知らないことが多いのでこの記事でコマンドとパラメーターを確認して,「AWS Copilot」の理解を深めたいと思います.

参照したドキュメント github.com

なお,CLI のバージョンは 0.4.0 で確認しております.

 » copilot -v
copilot version: v0.4.0

AWS Copilot CLI のコマンドの種類
copilot init
copilot app
copilot env
copilot svc
copilot task
- copilot task run
copilot pipeline
copilot deploy
copilot storage
- copilot storage init
copilot version
copilot completion
copilot docs
まとめ
- 関連記事

AWS Copilot CLI のコマンドの種類

「AWS Copilot CLI」が使えるコマンドとして次のものがあり,copilot helpを叩くとコマンドを確認できます.それぞれのコマンドとオプションをhelpを叩いて行くことでさらに詳細を確認できますので見ていきます.

init
app
env
svc
task
pipeline
deploy
storage
version
completion
docs

» copilot help
👩<200d>✈️ Launch and manage applications on Amazon ECS and AWS Fargate.

Commands
  Getting Started 🌱
    init        Create a new ECS application.
    docs        Open the copilot docs.

  Develop ✨
    app         Commands for applications.
                Applications are a collection of services and environments.

    env         Commands for environments.
                Environments are deployment stages shared between services.

    svc         Commands for services.
                Services are long-running Amazon ECS services.

    task        Commands for tasks.
                One-off Amazon ECS tasks that terminate once their work is done.

  Release 🚀
    pipeline    Commands for pipelines.
                Continuous delivery pipelines to release services.

    deploy      Deploy your service.

  Addons 🧸
    storage     Commands for working with storage and databases.

  Settings ⚙️
    version     Print the version number.
    completion  Output shell completion code.

Flags
  -h, --help   help for copilot

Examples
  Displays the help menu for the "init" command.
  `$ copilot init --help`

copilot init

copilot initコマンドは新しい ECS で動作するアプリケーションを作るためのコマンドです.各パラメーターを見ていきます.

パラメーター	用途
-a, --app string	アプリケーション名を指定する時に使う
--deploy	テスト環境にデプロイするために指定する時に使う
-d, --dockerfile string	Dockerfile へのパスを指定する時に使う
--port uint16	ポート指定する場合に使う
--profile string	AWS CLI で設定済みのプロファイル指定したい時に使う
-s, --svc string	サービズ名を指定する時に使う
-t, --svc-type string	サービスタイプを指定する時に使う `Load Balanced Web Service`か`Backend Service`を指定する
--tag string	サービスのコンテナイメージにタグを付与するために使う
-h, --help	ヘルプ情報を出したい時に使う

copilot app

copilot appコマンドはアプリケーションを作ったり,情報を参照するなどアプリケーションに関するコマンドです.各パラメーターを見ていきます.

copilot app init

copilot app initでは

パラメーター	用途
--domain string	Route53 で既存のドメイン名でアプリケーションを作成する
--resource-tags stringToString	リソースタグを付与する
-h, --help	ヘルプ情報を出したい時に使う

パラメーター	用途
--json	JSON で結果を返したい時に使う
-n, --name string	アプリを指定して情報を表示したい時に使う
-h, --help	ヘルプ情報を出したい時に使う

パラメーター	用途
--env-profiles stringToString	プロファイルを指定して削除するために使う
—yes	確認をスキップするために使う
-h, --help	ヘルプ情報を出したい時に使う

パラメーター	用途
--aws-access-key-id string	アクセスキーを指定する時に使う
--aws-secret-access-key string	シークレットアクセスキーを指定する時に使う
--aws-session-token string	一時的な認証情報を指定する時に使う
--default-config	default で指定した認証情報を使う時に使う
-n, --name string	環境名を指定するために使う
--prod	本番環境用のサービスを含んでいる場合に指定する
--profile string	プロファイルを指定する時に使う
-a,--app string	プアプリケーション名を指定する時に使う
-h, --help	ヘルプ情報を出したい時に使う
--import-private-subnets strings	既存のプライベートサブネットを指定する時に使う SubnetID を指定する
--import-public-subnets strings	既存のパブリックサブネットを指定する時に使う SubnetID を指定する
--import-vpc-id string	既存の VPC を指定する時に使う VPCID を指定する
--override-private-cidrs strings	プライベートサブネットとして使う
--override-public-cidrs strings	パブリックサブネットとして使う
--override-vpc-cidr ipNet	VPC の CIDR 指定する時に使う.

パラメーター	用途
-a,--app sting	アプリケーション名を指定する時に使う
-n,--name string	環境名を指定する時に使う
--profiles string	プロファイルを指定して削除するために使う
—yes	確認をスキップするために使う
-h, --help	ヘルプ情報を出したい時に使う

パラメーター	用途
-a, --app string	アプリ名を指定する時に使う
--json	JSON 形式で出力したい時に使う
-n, --name string	サービス名を指定する時に使う
--resources	サービスで使っているリソースを表示する時に使う
-h, --help	ヘルプ情報を出したい時に使う

パラメーター	用途
-a, --app string	アプリ名を指定する時に使う
--end-time string	JSON 形式で出力したい時に使う
-e, --env string	環境名を指定する時に使う
--follow	ログをストリーミングするかどうかを指定する時に使う
--json	JSON 形式で出力したい時に使う
--limit int	返されるログイベントの最大数を指定する時に使い,デフォルトは 10 で返却される
-n, --name string	サービス名を指定する時に使う
--since duration	5秒/2分/3時間といった時間を指定してそれよりも新しいログのみを表示したい時に使うなお,start-time / since のいずれか一方のみ指定できない
--start-time string	特定の日付以降のログのみを返す時に使う `--start-time 2006-01-02T15:04:05+00:00 --end-time 2006-01-02T15:05:05+00:00` のように指定する
--tasks strings	特定のタスク ID を指定すればそのタスクのログを返す
-h, --help	ヘルプ情報を出したい時に使う

パラメーター	用途
--app string	アプリケーションの名前を指定する時に使うオプションパラメーター default/subnets/security-groupsでは指定できない
--command string	オプションパラメーターでデフォルトのコマンドを上書きするために`docker run`に渡されるコマンドを指定する時に使う
--count int	オプションパラメーターでタスクの数を指定する時に使うデフォルトのタスク数は1
--cpu int	オプションパラメーターで各タスクに予約する CPU ユニットの数を指定する時に使うデフォルトの CPU ユニット数は256
--default	オプションパラメーターでデフォルトのクラスタとデフォルトのサブネットでタスクを実行する時に使う app/env/subnets では指定できない
--dockerfile string	Dockerfile へのファイルパスを指定する時に使うデフォルトのファイルパスはコマンド実行時のディレクトリ直下
--env string	オプションパラメーターで環境名を指定する時に使う default/subnets/security-groupsでは指定できない
--env-vars stringToString	オプションパラメーターで環境変数を指定する時に使う
--execution-role string	オプションパラメーターでコンテナエージェントに AWS の API 呼び出しの権限を付与するロールを指定する時に使う
--follow	オプションパラメーターでログをストリーム配信するかどうかを指定する時に使う
--image string	オプションパラメーターで Dockerfile をビルドする代わりに実行するイメージを指定する時に使う
--memory int	オプションパラメーターでタスクごとに確保するメモリ量を MiB 単位で指定する時に使うデフォルトの確保量は 512 MiB
--resource-tags stringToString	オプションパラメーターでタグを指定する時に使う app/env では指定できない
--subnets strings	オプションパラメーターでサブネット ID を指定する時に使う app/env/default では指定できない
--tag string	オプションパラメーターでコンテナイメージに`latest`タグを追加する時に使う
-n, --task-group-name string	オプションパラメーターでタスクのグループ名を指定する時に使う同じグループ名のタスクは同じリソースのセットを共有する
--task-role string	オプションパラメーターでタスクで使うロール名を指定する時に使う
-h, --help	ヘルプ情報を出したい時に使う

パラメーター	用途
-e, --environments strings	パイプラインにステージを追加する時に使う
-b,--git-branch string	パイプラインをキックするブランチを指定する時に使う
-t, --github-access-token string	GitHub のアクセストークンをしている時に使い,ファイルでも指定可
-u, --github-url string	サービスで使っている GitHub のリポジトリ URL を指定する時に使う
-h, --help	ヘルプ情報を出したい時に使う

パラメーター	用途
--delete-secret	パイプラインのソースリポジトリに関連付けられた Secrets Manager の秘密情報を削除する時に使う
-n, --name string	パイプライン名を指定する時に使う
-h, --help	ヘルプ情報を出したい時に使う

パラメーター	用途
-t, --storage-type string	`DynamoDB` か `S3` のどちらをストレージとして使うかを指定する時に使う
-n, --name string	作成するストレージ名を指定する時に使う
-s, --svc string	関連づけるサービス名を指定する時に使う

パラメーター	用途
--lsi stringArray	LSI を指定する時に使う `<keyName>:<dataType>`のフォーマットで指定する
--no-lsi	LSI の設定をスキップする時に使う
--no-sort	ソートキーの設定をスキップする時に使う
--partition-key string	パーティションキーを指定する時に使う `<keyName>:<dataType>`のフォーマットで指定する
--sort-key string	ソートキーを指定する時に使う `<keyName>:<dataType>`のフォーマットで指定する

AWS Copilot CLI のコマンドの種類

copilot init

copilot app

copilot app init

copilot app ls

copilot app show

copilot app delete

copilot env

copilot env init

copilot env ls

copilot env shw

copilot env delete

copilot svc

copilot svc init

copilit svc show

copilot svc ls

copilot svc logs

copilot svc status

copilot svc package

copilot svc deploy

サービスのデプロイまでのステップ

copilot svc delete

copilot task

copilot task run

copilot pipeline

copilot pipeline init

copilot pipeline update

copilot pipeline show

copilot pipeline status

copilot pipeline delete

copilot deploy

copilot storage

copilot storage init

copilot version

copilot completion

copilot docs

まとめ

関連記事