Menu
Amazon EC2 Container Service
Developer Guide (API Version 2014-11-13)

ecs-cli up

Description

Create the ECS cluster (if it does not already exist) and the AWS resources required to set up the cluster.

This command creates a new AWS CloudFormation stack called amazon-ecs-cli-setup-cluster_name. You can view the progress of the stack creation in the AWS Management Console.

Syntax

ecs-cli up --keypair keypair_name --capability-iam [--size n] [--azs availability_zone_1,availability_zone_2] [--security-group security_group_id] [--cidr ip_range] [--port port_number] [--subnets subnet_1,subnet_2] [--vpc vpc_id] [--instance-type instance_type] [--image-id ami_id] [--help]

Options

Name Description

--verbose, --debug

Provides more verbose output for debugging purposes.

Required: No

--keypair keypair_name

Specifies the name of an existing Amazon EC2 key pair to enable SSH access to the EC2 instances in your cluster.

For more information about creating a key pair, see Setting Up with Amazon EC2 in the Amazon EC2 User Guide for Linux Instances.

Type: String

Required: Yes

--capability-iam

Acknowledges that this command may create IAM resources.

Required: Yes

--size n

Specifies the number of instances to launch and register to the cluster.

Type: Integer

Default: 1

Required: No

--azs availability_zone_1,availability_zone_2

Specifies a comma-separated list of two VPC Availability Zones in which to create subnets (these zones must have the available status). We recommend this option if you do not specify a VPC ID with the --vpc option.

Warning

Leaving this option blank can result in failure to launch container instances if an unavailable zone is chosen at random.

Type: String

Required: No

--security-group security_group_id

Specifies an existing security group to associate with your container instances. If you do not specify a security group here, then a new one is created.

For more information, see Security Groups in the Amazon EC2 User Guide for Linux Instances.

Required: No

--cidr ip_range

Specifies a CIDR/IP range for the security group to use for container instances in your cluster.

Note

This parameter is ignored if an existing security group is specified with the --security-group option.

Type: CIDR/IP range

Default: 0.0.0.0/0

Required: No

--port port_number

Specifies a port to open on the security group to use for container instances in your cluster.

Note

This parameter is ignored if an existing security group is specified with the --security-group option.

Type: Integer

Default: 80

Required: No

--subnets subnet_1,subnet_2

Specifies a comma-separated list of existing VPC subnet IDs in which to launch your container instances.

Type: String

Required: This option is required if you specify a VPC with the --vpc option.

--vpc vpc_id

Specifies the ID of an existing VPC in which to launch your container instances. If you specify a VPC ID, you must specify a list of existing subnets in that VPC with the --subnets option. If you do not specify a VPC ID, a new VPC is created with two subnets.

Type: String

Required: No

--instance-type instance_type

Specifies the EC2 instance type for your container instances.

For more information on EC2 instance types, see Amazon EC2 Instances.

Type: String

Default: t2.micro

Required: No

--image-id ami_id

Specifies the Amazon EC2 AMI ID to use for your container instances.

Type: String

Default: The latest Amazon ECS–optimized AMI for the specified region.

Required: No

--help, -h

Shows the help text for the specified command.

Required: No

Examples

Example

This example brings up a cluster of 4 c4.large instances and configures them to use the EC2 key pair called id_rsa.

Copy
ecs-cli up --keypair id_rsa --capability-iam --size 4 --instance-type c4.large

Output:

INFO[0000] Created cluster                               cluster=ecs-cli
INFO[0000] Waiting for your cluster resources to be created
INFO[0001] Cloudformation stack status                   stackStatus=CREATE_IN_PROGRESS
INFO[0061] Cloudformation stack status                   stackStatus=CREATE_IN_PROGRESS
INFO[0121] Cloudformation stack status                   stackStatus=CREATE_IN_PROGRESS
INFO[0181] Cloudformation stack status                   stackStatus=CREATE_IN_PROGRESS