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

ecs-cli pull

Description

Pull an image from an Amazon ECR repository.

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 pull [--registry-id registry_id] [--region region] ECR_REPOSITORY[:TAG|@DIGEST] [--help]

Options

Name Description

--registry-id registry_id

Specifies the Amazon ECR registry ID from which to pull the image. By default, images are pulled from the current AWS account.

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

--help, -h

Shows the help text for the specified command.

Required: No

Examples

Example 1

This example pulls a local image called amazonlinux from an Amazon ECR repository with the same name.

ecs-cli pull amazonlinux

Output:

INFO[0000] Getting AWS account ID... INFO[0000] Pulling image repository="aws_account_id.dkr.ecr.us-east-1.amazonaws.com/amazonlinux" tag= INFO[0129] Image pulled