AWS Documentation » Amazon Elastic Container Service » Developer Guide » Using the Amazon ECS Command Line Interface » Amazon ECS Command Line Reference » ecs-cli compose start

ecs-cli compose start

Description

Starts a single Amazon ECS task from the task definition created from your compose file.

Important

Some features described may only be available with the latest version of the ECS CLI. To obtain the latest version, see Installing the Amazon ECS CLI.

Syntax

ecs-cli compose [--verbose] [--file compose-file] [--project-name project-name] start [arguments] [--help]

Options

Name	Description
--verbose, --debug	Increases the verbosity of command output to aid in diagnostics. Required: No
--file, -f compose-file	Specifies the Docker compose file to use. At this time, the latest version of the Amazon ECS CLI supports Docker compose file syntax versions 1 and 2. If the COMPOSE_FILE environment variable is set when ecs-cli compose is run, then the Docker compose file is set to the value of that environment variable. Type: String Default: ./docker-compose.yml Required: No
--project-name, -p project-name	Specifies the project name to use. If the COMPOSE_PROJECT_NAME environment variable is set when ecs-cli compose is run, then the project name is set to the value of that environment variable. Type: String Default: The current directory name. Required: No
--task-role-arn role_value	Specifies the short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. Type: String Required: No
--ecs-params	Specifies the ECS parameters that are not native to Docker compose files. For more information, see Using Amazon ECS Parameters. Default: ./ecs-params.yml Required: No
--cluster, -c cluster_name	Specifies the ECS cluster name to use. Defaults to the cluster configured using the configure command. Type: String Required: No
--region, -r region	Specifies the AWS Region to use. Defaults to the cluster configured using the configure command. Type: String Required: No
--ecs-profile ecs_profile	Specifies the name of the ECS profile configuration to use. Defaults to the profile configured using the configure profile command. Type: String Required: No
--aws-profile aws_profile	Specifies the AWS profile to use. Enables you to use the AWS credentials from an existing named profile in ~/.aws/credentials. Type: String Required: No
--cluster-config cluster_config_name	Specifies the name of the ECS cluster configuration to use. Defaults to the cluster configuration set as the default. Type: String Required: No
--launch-type launch_type	Specifies the launch type to use. Available options are FARGATE or EC2. For more information about launch types, see Amazon ECS Launch Types. This overrides the default launch type stored in your cluster configuration. Type: String Required: No
--create-log-groups	Creates the CloudWatch log groups specified in your compose files. Required: No
--help, -h	Shows the help text for the specified command. Required: No

Examples

Run a Task

This example creates a task definition from the hello-world.yml compose file. Additional ECS parameters are specified for task networking configuration for the Fargate launch type. Then a single task is run using that task definition.

Example Docker Compose file, named hello-world.yml:

version: '3'
services:
  nginx:
    image: nginx:latest
    ports:
      - "80:80"
    logging:
      driver: awslogs
      options: 
        awslogs-group: tutorial
        awslogs-region: us-east-1
        awslogs-stream-prefix: nginx

Example ECS parameters file, named ecs-params.yml:

version: 1
task_definition:
  task_execution_role: ecsTaskExecutionRole
  ecs_network_mode: awsvpc
  task_size:
    mem_limit: 0.5GB
    cpu_limit: 256
run_params:
  network_configuration:
    awsvpc_configuration:
      subnets:
        - subnet-abcd1234
        - subnet-dbca4321
      security_groups:
        - sg-abcd1234
      assign_public_ip: ENABLED

Command:

ecs-cli compose --file hello-world.yml --ecs-params ecs-params.yml start --launch-type FARGATE --create-log-groups

Output:

INFO[0000] Using ECS task definition                     TaskDefinition=ecscompose-hello-world:5