ecs-cli
Description
The Amazon ECS command line interface (CLI) provides high-level commands to simplify
creating, updating, and monitoring clusters and tasks from a local development
environment. The Amazon ECS CLI supports Docker
Compose
For a quick walkthrough of the Amazon ECS CLI, see the Tutorial: Creating a cluster with a Fargate task using the Amazon ECS CLI.
Help text is available for each individual subcommand with ecs-cli
subcommand
--help.
Some features described might only be available with the latest version of the Amazon ECS CLI. For more information about obtaining the latest version, see Installing the Amazon ECS CLI.
Syntax
ecs-cli [--version]
[
subcommand
] [--help]
Options
Name |
Description |
---|---|
|
Prints the version information for the Amazon ECS CLI. Required: No |
|
Show the help text for the specified command. Required: No |
Available Subcommands
The ecs-cli command supports the following subcommands:
- configure
-
Configures your AWS credentials, the Region to use, and the ECS cluster name to use with the Amazon ECS CLI. For more information, see ecs-cli configure.
- migrate
-
Migrates a legacy configuration file (ECS CLI v0.6.6 and older) to the new configuration file format (ECS CLI v1.0.0 and later). The command prints a summary of the changes to be made and then asks for confirmation to proceed. For more information, see ecs-cli configure migrate.
- up
-
Creates the ECS cluster (if it does not already exist) and the AWS resources required to set up the cluster. For more information, see ecs-cli up.
- down
-
Deletes the AWS CloudFormation stack that was created by ecs-cli up and the associated resources. For more information, see ecs-cli down.
- scale
-
Modifies the number of container instances in an ECS cluster. For more information, see ecs-cli scale.
- logs
-
Retrieves container logs from CloudWatch Logs. Only valid for tasks that use the
awslogs
driver and has a log stream prefix specified. For more information, see ecs-cli logs. - ps
-
Lists all of the running containers in an ECS cluster. For more information, see ecs-cli ps.
- push
-
Pushes an image to an Amazon ECR repository. For more information, see ecs-cli push.
- pull
-
Pulls an image from an ECR repository. For more information, see ecs-cli pull.
- images
-
Lists all of the running containers in an ECS cluster. For more information, see ecs-cli images.
- license
-
Prints the
LICENSE
files for the Amazon ECS CLI and its dependencies. For more information, see ecs-cli license. - compose
-
Executes docker-compose–style commands on an ECS cluster. For more information, see ecs-cli compose.
- help
-
Shows the help text for the specified command.