Amazon EC2 Container Service
开发人员指南 (API Version 2014-11-13)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。点 击 Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

ecs-cli configure

说明

配置您的 AWS 凭证、要使用的 AWS 区域、资源创建前缀以及要与 Amazon ECS CLI 结合使用的 ECS 集群名称。生成的配置将存储在 ~/.ecs/config 文件中。

每次运行 ecs-cli configure 命令时,~/.ecs/config 中的配置值将替换为最新命令中的值 (如果现有配置参数未与其关联的选项标记或环境变量一起指定,这些参数将被删除或替换为默认值)。

语法

ecs-cli configure --cluster cluster_name [--region region] [--access-key aws_access_key_id] [--secret-key aws_secret_access_key] [--profile profile_name] [--compose-project-name-prefix prefix] [--compose-service-name-prefix prefix] [--cfn-stack-name-prefix prefix] [--help]

选项

名称 描述

--cluster, -c cluster_name

指定要使用的 ECS 集群名称。如果该集群不存在,则当您尝试使用 ecs-cli up 命令向集群添加资源时将创建该集群。如果在运行 ecs-cli configure 时设置 ECS_CLUSTER 环境变量,则群集将设置为该环境变量的值。

类型:字符串

必需:否

--region, -r region

指定要使用的区域。如果在运行 ecs-cli configure 时设置了 AWS_REGION 环境变量,则该区域将设置为该环境变量的值。

类型:字符串

必需:否

--access-key aws_access_key_id

指定要使用的 AWS 访问密钥。如果在运行 ecs-cli configure 时设置 AWS_ACCESS_KEY_ID 环境变量,则 AWS 访问密钥 ID 将设置为该环境变量的值。

类型:字符串

必需:否

--secret-key aws_secret_access_key

指定要使用的 AWS 私有密钥。如果在运行 ecs-cli configure 时设置 AWS_SECRET_ACCESS_KEY 环境变量,则 AWS 秘密访问密钥将设置为该环境变量的值。

类型:字符串

必需:否

--profile, -p profile_name

使用 ~/.aws/credentials 中的现有已命名配置文件指定 AWS 凭证。如果在运行 ecs-cli configure 时设置 AWS_PROFILE 环境变量,则 AWS 命名配置文件将设置为该环境变量的值。

类型:字符串

必需:否

--compose-project-name-prefix prefix

指定要添加到从复合文件注册的 ECS 任务定义的前缀。您可以使用此选项指定一个空字符串 (--compose-project-name-prefix "") 来省略默认前缀。

重要

此前缀用于对由 Amazon ECS CLI 创建的资源进行命名并稍后管理这些资源。如果配置的前缀与创建资源时使用的前缀匹配,则只能从 Amazon ECS CLI 对使用此前缀创建的资源进行寻址。在更改前缀值之前,您应考虑对任何活动资源的影响。

类型:字符串

默认值:ecscompose-

必需:否

--compose-service-name-prefix prefix

指定要添加到从复合文件创建的 ECS 服务的前缀。您可以通过此选项指定一个空字符串 (--compose-service-name-prefix "") 以省略默认前缀。

重要

此前缀用于对由 Amazon ECS CLI 创建的资源进行命名并稍后管理这些资源。如果配置的前缀与创建资源时使用的前缀匹配,则只能从 Amazon ECS CLI 对使用此前缀创建的资源进行寻址。在更改前缀值之前,您应考虑对任何活动资源的影响。

类型:字符串

默认值:ecscompose-service-

必需:否

--cfn-stack-name-prefix prefix

指定要添加到通过 ecs-cli up 创建的 AWS CloudFormation 堆栈的前缀。您可以使用此选项指定一个空字符串 (--cfn-stack-name-prefix "") 来省略默认前缀。

重要

此前缀用于对由 Amazon ECS CLI 创建的资源进行命名并稍后管理这些资源。如果配置的前缀与创建资源时使用的前缀匹配,则只能从 Amazon ECS CLI 对使用此前缀创建的资源进行寻址。在更改前缀值之前,您应考虑对任何活动资源的影响。

类型:字符串

默认值:amazon-ecs-cli-setup-

必需:否

--help, -h

显示指定命令的帮助文本。

必需:否

示例

示例

此示例将 Amazon ECS CLI 配置为创建和使用 ecs-cli 区域中名为 us-west-2 的群集。

Copy
ecs-cli configure --region us-west-2 --access-key $AWS_ACCESS_KEY_ID --secret-key $AWS_SECRET_ACCESS_KEY --cluster ecs-cli

输出:

INFO[0000] Saved ECS CLI configuration for cluster (ecs-cli)

示例

此示例将 Amazon ECS CLI 配置为创建和/或使用 ecs-cli 区域中名为 us-west-2 群集,并在以后创建资源时省略默认的 Amazon ECS CLI 前缀。

注意

无法从 Amazon ECS CLI 对使用默认前缀创建的任何现有资源 (例如,任务定义、服务或 AWS CloudFormation 堆栈) 进行寻址,直到配置的前缀与创建资源时创建的前缀匹配。

Copy
ecs-cli configure --region us-west-2 --access-key $AWS_ACCESS_KEY_ID --secret-key $AWS_SECRET_ACCESS_KEY --cluster ecs-cli --compose-project-name-prefix "" --compose-service-name-prefix "" --cfn-stack-name-prefix ""

输出:

INFO[0000] Saved ECS CLI configuration for cluster (ecs-cli)

本页内容: