Amazon ECS 服务定义参数

类型：字符串

必需：是

容量提供程序的短名称或完整的 Amazon 资源名称（ARN）。

类型：整数

有效范围：介于 0 到 1000 之间的整数。

必需：否

权重值指明使用指定容量提供程序的已启动任务总数的相对百分比。

例如，假定您的策略包含两个容量提供程序，并且两个容量提供程序的权重均为 1。当满足基准时，任务会在两个容量提供程序之间均匀分配。按照相同的逻辑，假定您指定 capacityProviderA 的权重为 1，并指定 capacityProviderB 的权重为 4，那么，对于使用 capacityProviderA 运行的每个任务，都会有四个任务使用 capacityProviderB。

类型：整数

有效范围：介于 0 到 100000 万之间的整数。

必需：否

基准值指明在指定的容量提供程序上至少运行多少个任务。在一个容量提供程序策略中，只能有一个容量提供程序策略定义了基准。

类型：整数

必需：否

如果服务使用滚动更新 (ECS) 部署类型，maximumPercent 参数表示在部署期间允许处于 RUNNING、STOPPING 或 PENDING 状态的服务任务数上限。其表示为向下取整到最近整数的 desiredCount 的百分比。您可以使用此参数定义部署批次大小。例如，如果服务使用 REPLICA 服务调度器且任务的 desiredCount 为 4，maximumPercent 值为 200%，则调度器会在停止 4 个旧任务之前开始 4 个新任务。这样做的前提是具有执行此操作所需的集群资源。使用 REPLICA 服务计划程序的服务的默认 maximumPercent 值为 200%。

只要有用于启动替换任务的集群资源可用，Amazon ECS 调度器就会使用此参数替换运行状况不佳的任务，方法是先启动替换任务，然后停止运行状况不佳的任务。有关调度器如何替换运行状况不佳的任务的更多信息，请参阅 Amazon ECS 服务。

如果服务使用的是 DAEMON 服务调度器类型，则 maximumPercent 应保持在 100%。这是默认值。

部署期间的最大任务数为 desiredCount 乘以 maximumPercent/100（向下取整到最近的整数值）。

如果服务使用蓝/绿 (CODE_DEPLOY) 或 EXTERNAL 部署类型，并且具有使用 EC2 启动类型的任务，则最大百分比值将设置为默认值。该值用于定义当容器实例处于 DRAINING 状态时该服务中仍保持在 RUNNING 状态的任务数上限。

如果服务使用蓝绿 (CODE_DEPLOY) 或 EXTERNAL 部署类型，并且服务中的任务使用 Fargate 启动类型，则不会使用最大百分比值。在描述您的服务时仍会返回该值。

类型：整数

必需：否

如果服务使用滚动更新（ECS）部署类型，minimumHealthyPercent 则表示在部署期间必须处于 RUNNING 状态的服务任务数下限。其表示为向上取整到最近整数的 desiredCount 的百分比。您可以使用此参数进行部署，而无需使用额外的集群容量。

例如，如果您的服务的任务 desiredCount 为 4，minimumHealthyPercent 为 50% 且 maximumPercent 为 100%，则服务调度器可能先停止两个现有任务以释放集群容量，然后再启动两个新任务。

如果有任何任务运行状况不佳，并且 maximumPercent 不允许 Amazon ECS 调度器启动替换任务，则调度器将使用 minimumHealthyPercent 作为约束条件逐一停止运行状况不佳的任务，清理容量以便启动替换任务。有关调度器如何替换运行状况不佳的任务的更多信息，请参阅 Amazon ECS 服务。

对于不使用负载均衡器的服务，请注意以下事项：

对于确实使用负载均衡器的服务，请注意以下事项：

minimumHealthyPercent 的副本服务的默认值为 100%。使用 DAEMON 服务调度的原定设置 minimumHealthyPercent 值对于 Amazon CLI、Amazon 开发工具包和 API 为 0%，对于 Amazon Web Services Management Console 为 50%。

部署期间的最小正常任务数为 desiredCount 乘以 minimumHealthyPercent/100（向上取整到最近的整数值）。

如果服务使用蓝/绿 (CODE_DEPLOY) 或 EXTERNAL 部署类型，并且正在运行使用 EC2 启动类型的任务，则最小正常运行百分比值将设置为默认值。该值用于定义当容器实例处于 DRAINING 状态时该服务中仍保持在 RUNNING 状态的任务数下限。

如果服务使用蓝色/绿色 (CODE_DEPLOY) 或 EXTERNAL 部署类型，并且正在运行使用 Fargate 启动类型的任务，则不会使用最小健康百分比值，尽管在描述服务时会返回该值。

类型：字符串

有效值：ECS |CODE_DEPLOY |EXTERNAL

必需：是

要使用的部署控制器类型。部署控制器有三种类型：

类型：字符串

必需：否

约束类型。使用 distinctInstance 确保特定组中的每个任务在不同的容器实例上运行。使用 memberOf 将选择限制为一组有效的候选。任务定义不支持值 distinctInstance。

类型：字符串

必需：否

应用于约束的集群查询语言表达式。如果约束类型为 distinctInstance，则不能指定表达式。有关更多信息，请参阅 创建表达式，以为 Amazon ECS 任务定义容器实例。

类型：字符串

有效值：random |spread |binpack

必需：否

放置策略的类型。random 放置策略将任务随机放置在可用的候选上。spread 放置策略基于 field 参数将任务均匀地放置在可用候选上。binpack 策略将任务放置在可用资源数量最少（使用 field 参数指定）的可用候选上。例如，如果对内存使用装填，则会将任务放置到剩余内存最少但足以运行该任务的实例上。

类型：字符串

必需：否

应用放置策略的字段。对于 spread 放置策略，有效值为 instanceId（或具有相同效果的 host）或应用于容器实例的任何平台或自定义属性，例如 attribute:ecs.availability-zone。对于 binpack 放置策略，有效值为 cpu 和 memory。对于 random 放置策略，该字段未用。

类型：字符串

长度限制：长度下限为 1。最大长度为 128。

必需：否

构成标签的键-值对的一个部分。键是一种常见的标签，行为类似于更具体的标签值的类别。

类型：字符串

长度约束：最小长度为 0。长度上限为 256。

必需：否

构成标签的键-值对的可选部分。值充当标签类别（键）中的描述符。

类型：对象

必需：否

表示任务或服务的子网和安全组的对象。

类型：字符串

必需：否

与服务关联的 Elastic Load Balancing 目标组的完整 Amazon 资源名称（ARN）。

目标组 ARN 仅在使用 Application Load Balancer 或 Network Load Balancer时指定。

类型：字符串

必需：否

要与该服务关联的负载均衡器的名称。

如果您使用的是 Application Load Balancer 或 Network Load Balancer，则会省略负载均衡器名称参数。

类型：字符串

必需：否

要与负载均衡器关联的容器的名称（与在容器定义中显示的相同）。

类型：整数

必需：否

要与负载均衡器关联的容器上的端口。此端口必须对应于服务中的任务所使用任务定义中的 containerPort。对于使用 EC2 启动类型的任务，容器实例必须允许端口映射的 hostPort 上的入站流量。

类型：布尔值

必需：是

指定是否将 Service Connect 与此服务结合使用。

类型：字符串

必需：否

与 Service Connect 结合使用的 Amazon Cloud Map 命名空间的 Amazon 资源名称（ARN）短名称或全称。命名空间必须与 Amazon ECS 服务和集群在同一个 Amazon Web Services 区域 内。命名空间的类型不影响 Service Connect。有关 Amazon Cloud Map 的更多信息，请参阅《Amazon Cloud Map 开发人员指南》中的使用服务。

类型： 对象数组

必需：否

一组 Service Connect 服务对象。这些是其他 Amazon ECS 服务用来连接到此服务的名称和别名（也称为端点）。

对于作为命名空间成员的“客户端”Amazon ECS 服务，只有连接到命名空间内的其他服务时，才需要此字段。例如，接受来自附加到服务的负载均衡器或通过其他方式所传入请求的前端应用程序。

对象从任务定义中选择一个端口，为 Amazon Cloud Map 服务分配一个名称，并为客户端应用程序分配别名（也称为端点）数组和端口，以供客户端应用程序引用此服务。

类型：字符串

必需：否

服务注册表的 Amazon 资源名称（ARN）。当前支持的服务注册表是 Amazon Cloud Map。有关更多信息，请参阅 Amazon Cloud Map 开发人员指南中的使用服务。

类型：整数

必需：否

在服务发现服务指定 SRV 记录时使用的端口值。如果使用 awsvpc 网络模式和 SRV 记录，则需要此字段。

类型：字符串

必需：否

用于服务发现服务的容器名称值。此值可在任务定义中指定。如果服务任务指定的任务定义使用 bridge 或 host 网络模式，则必须从任务定义中指定 containerName 和 containerPort 组合。如果服务任务指定的任务定义使用 awsvpc 网络模式，并且使用类型 SRV DNS 记录，则必须指定 containerName 和 containerPort 组合或 port 值，但不能同时指定二者。

类型：整数

必需：否

用于服务发现服务的端口值。此值可在任务定义中指定。如果服务任务指定的任务定义使用 bridge 或 host 网络模式，则必须从任务定义中指定 containerName 和 containerPort 组合。如果服务任务指定的任务定义使用 awsvpc 网络模式，并且使用类型 SRV DNS 记录，则必须指定 containerName 和 containerPort 组合或 port 值，但不能同时指定二者。

类型：字符串

必需：是

创建或更新服务时配置的卷的名称。最多可允许 255 个字母（大写和小写字母）、数字、下划线（_）和连字符（-）。此值必须与任务定义中指定的卷名称相匹配。

类型：对象

必需：否

用于创建 Amazon EBS 卷的卷配置，这些卷附加到在创建或更新服务时由服务维护的任务。每个任务附加一个卷。