Amazon Elastic Container Service

Developer Guide (API Version 2014-11-13)

What is Amazon ECS?
Setting Up
Docker Basics for Amazon ECS
Getting Started
Cleaning Up
AWS Fargate
- AWS Fargate Platform Versions
Clusters
- Creating a Cluster
- Scaling a Cluster
- Deleting a Cluster
Container Instances
- Container Instance AMIs
  - Amazon ECS-Optimized AMI
- Subscribing to Amazon ECS–Optimized AMI Update Notifications
- Launching a Container Instance
- Bootstrap Container Instances
  - Example User Data Scripts
- Connect to Your Container Instance
- CloudWatch Logs
- Container Instance Draining
- Memory Management
- Managing Container Instances Remotely
- Starting a Task at Container Instance Launch Time
- Deregister Container Instances
Container Agent
- Installing the Amazon ECS Container Agent
- Container Agent Versions
- Updating the Amazon ECS Container Agent
  - Updating the Amazon ECS Container Agent on the Amazon ECS-Optimized AMI
  - Manually Updating the Amazon ECS Container Agent (for Non-Amazon ECS-optimized AMIs)
- Amazon ECS Container Agent Configuration
- Automated Task and Image Cleanup
- Private Registry Authentication
- Container Metadata File
- Task Metadata Endpoint
- Amazon ECS Container Agent Introspection
- HTTP Proxy Configuration
Task Definitions
- Application Architecture
- Creating a Task Definition
- Task Definition Parameters
- Using Data Volumes in Tasks
  - Docker Volumes
  - Bind Mounts
- Task Networking
- Launch Types
- Using the awslogs Log Driver
- Example Task Definitions
- Updating a Task Definition
- Deregistering Task Definitions
Scheduling Tasks
- Running Tasks
- Task Placement
- Scheduled Tasks (cron)
- Task Lifecycle
- Task Retirement
- Creating a Scheduled Task Using the AWS CLI
Services
- Service Definition Parameters
- Service Load Balancing
- Service Auto Scaling
  - Target Tracking Scaling Policies
  - Step Scaling Policies
- Service Discovery
  - Tutorial: Creating a Service Using Service Discovery
- Creating a Service
- Updating a Service
- Deleting a Service
- Service Throttle Logic
Repositories
Monitoring
- Monitoring Tools
- CloudWatch Metrics
  - Viewing Amazon ECS Metrics
  - Tutorial: Scaling with CloudWatch Alarms
- CloudWatch Events
IAM Policies, Roles, and Permissions
- Policy Structure
- Supported Resource-Level Permissions
- Creating IAM Policies
- Managed Policies and Trust Relationships
  - Amazon ECS Managed Policies and Trust Relationships
  - Amazon ECR Managed Policies
- Amazon ECS Container Instance IAM Role
- Amazon ECS Task Execution IAM Role
- Using Service-Linked Roles
- Amazon ECS Service Scheduler IAM Role
- Amazon ECS Service Auto Scaling IAM Role
- Amazon Elastic Container Service Task Role
- CloudWatch Events IAM Role
- IAM Roles for Tasks
- Amazon ECS IAM Policy Examples
Using the ECS CLI
- Installing the Amazon ECS CLI
- Configuring the Amazon ECS CLI
- Migrating Configuration Files
- Tutorial: Creating a Cluster with a Fargate Task Using the ECS CLI
- Tutorial: Creating a Cluster with an EC2 Task Using the ECS CLI
- Amazon ECS Command Line Reference
Using the AWS CLI
- Tutorial: Creating a Cluster with a Fargate Task Using the AWS CLI
- Tutorial: Creating a Cluster with a EC2 Task Using the AWS CLI
Common Use Cases
Tutorial: Creating a VPC
Tutorial: Using Amazon EFS
Tutorial: Continuous Deployment with AWS CodePipeline
Service Limits
Logging Amazon ECS API Calls with AWS CloudTrail
Troubleshooting
- Checking Stopped Tasks for Errors
- Service Event Messages
- Invalid CPU or Memory Value Specified
- Cannot Pull Container Image Error
- CannotCreateContainerError: API error (500): devmapper
- Troubleshooting Service Load Balancers
- Enabling Docker Debug Output
- Amazon ECS Log File Locations
- Amazon ECS Logs Collector
- Agent Introspection Diagnostics
- Docker Diagnostics
- API failures Error Messages
- Troubleshooting IAM Roles for Tasks
Windows Containers
- Getting Started with Windows Containers
- Windows Task Definitions
- Windows IAM Roles for Tasks
- Pushing Windows Images to Amazon ECR
Document History
AWS Glossary

Using the Amazon ECS Command Line Interface

The Amazon Elastic Container Service (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 files (Version 1, Version 2, and Version 3), a popular open-source specification for defining and running multi-container applications. Use the CLI as part of your everyday development and testing cycle as an alternative to the AWS Management Console.

The latest version of the Amazon ECS CLI is 1.7.0. For release notes, see Changelog.

Note

The source code for the Amazon ECS CLI is available on GitHub. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.

Topics

Warning Javascript is disabled or is unavailable in your browser.

To use the AWS Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

« Previous Next »

© 2018, Amazon Web Services, Inc. or its affiliates. All rights reserved.