Skip to content

Commit 9a3a3f6

Browse files
author
awstools
committed
docs(client-ecs): Documentation only updates to address Amazon ECS tickets.
1 parent 7d309f3 commit 9a3a3f6

File tree

3 files changed

+176
-155
lines changed

3 files changed

+176
-155
lines changed

‎clients/client-ecs/src/endpoint/ruleset.ts‎

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,27 @@ import { RuleSetObject } from "@smithy/types";
66
or see "smithy.rules#endpointRuleSet"
77
in codegen/sdk-codegen/aws-models/ecs.json */
88

9-
const q="required",
10-
r="fn",
11-
s="argv",
12-
t="ref";
13-
const a="isSet",
14-
b="tree",
15-
c="error",
16-
d="endpoint",
17-
e="PartitionResult",
18-
f={[q]:false,"type":"String"},
19-
g={[q]:true,"default":false,"type":"Boolean"},
20-
h={[t]:"Endpoint"},
21-
i={[r]:"booleanEquals",[s]:[{[t]:"UseFIPS"},true]},
22-
j={[r]:"booleanEquals",[s]:[{[t]:"UseDualStack"},true]},
23-
k={},
24-
l={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsFIPS"]}]},
25-
m={[r]:"booleanEquals",[s]:[true,{[r]:"getAttr",[s]:[{[t]:e},"supportsDualStack"]}]},
26-
n=[i],
27-
o=[j],
28-
p=[{[t]:"Region"}];
29-
const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[r]:a,[s]:[h]}],type:b,rules:[{conditions:n,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:o,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]},{conditions:[{[r]:a,[s]:p}],type:b,rules:[{conditions:[{[r]:"aws.partition",[s]:p,assign:e}],type:b,rules:[{conditions:[i,j],type:b,rules:[{conditions:[l,m],type:b,rules:[{endpoint:{url:"https://ecs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:n,type:b,rules:[{conditions:[l],type:b,rules:[{endpoint:{url:"https://ecs-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:o,type:b,rules:[{conditions:[m],type:b,rules:[{endpoint:{url:"https://ecs.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://ecs.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]};
9+
const s="required",
10+
t="fn",
11+
u="argv",
12+
v="ref";
13+
const a=true,
14+
b="isSet",
15+
c="booleanEquals",
16+
d="error",
17+
e="endpoint",
18+
f="tree",
19+
g="PartitionResult",
20+
h={[s]:false,"type":"String"},
21+
i={[s]:true,"default":false,"type":"Boolean"},
22+
j={[v]:"Endpoint"},
23+
k={[t]:c,[u]:[{[v]:"UseFIPS"},true]},
24+
l={[t]:c,[u]:[{[v]:"UseDualStack"},true]},
25+
m={},
26+
n={[t]:"getAttr",[u]:[{[v]:g},"supportsFIPS"]},
27+
o={[t]:c,[u]:[true,{[t]:"getAttr",[u]:[{[v]:g},"supportsDualStack"]}]},
28+
p=[k],
29+
q=[l],
30+
r=[{[v]:"Region"}];
31+
const _data={version:"1.0",parameters:{Region:h,UseDualStack:i,UseFIPS:i,Endpoint:h},rules:[{conditions:[{[t]:b,[u]:[j]}],rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:j,properties:m,headers:m},type:e}],type:f},{conditions:[{[t]:b,[u]:r}],rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:g}],rules:[{conditions:[k,l],rules:[{conditions:[{[t]:c,[u]:[a,n]},o],rules:[{endpoint:{url:"https://ecs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:p,rules:[{conditions:[{[t]:c,[u]:[n,a]}],rules:[{endpoint:{url:"https://ecs-fips.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:q,rules:[{conditions:[o],rules:[{endpoint:{url:"https://ecs.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:m,headers:m},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://ecs.{Region}.{PartitionResult#dnsSuffix}",properties:m,headers:m},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]};
3032
export const ruleSet: RuleSetObject = _data;

‎clients/client-ecs/src/models/models_0.ts‎

Lines changed: 89 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@ export interface ClusterServiceConnectDefaultsRequest {
735735
* Cloud Map namespace with the "API calls" method of instance discovery only. This instance
736736
* discovery method is the "HTTP" namespace type in the Command Line Interface. Other types of instance
737737
* discovery aren't used by Service Connect.</p>
738-
* <p>If you update the service with an empty string <code>""</code> for the namespace name,
738+
* <p>If you update the cluster with an empty string <code>""</code> for the namespace name,
739739
* the cluster configuration for Service Connect is removed. Note that the namespace will
740740
* remain in Cloud Map and must be deleted separately.</p>
741741
* <p>For more information about Cloud Map, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html">Working
@@ -4049,13 +4049,11 @@ export type EnvironmentFileType = (typeof EnvironmentFileType)[keyof typeof Envi
40494049

40504050
/**
40514051
* @public
4052-
* <p>A list of files containing the environment variables to pass to a container. You can
4053-
* specify up to ten environment files. The file must have a <code>.env</code> file
4054-
* extension. Each line in an environment file should contain an environment variable in
4052+
* <p>A list of files containing the environment variables to pass to a container. You can specify
4053+
* up to ten environment files. The file must have a <code>.env</code> file extension. Each
4054+
* line in an environment file should contain an environment variable in
40554055
* <code>VARIABLE=VALUE</code> format. Lines beginning with <code>#</code> are treated
4056-
* as comments and are ignored. For more information about the environment variable file
4057-
* syntax, see <a href="https://docs.docker.com/compose/env-file/">Declare default
4058-
* environment variables in file</a>.</p>
4056+
* as comments and are ignored.</p>
40594057
* <p>If there are environment variables specified using the <code>environment</code>
40604058
* parameter in a container definition, they take precedence over the variables contained
40614059
* within an environment file. If multiple environment files are specified that contain the
@@ -4071,6 +4069,18 @@ export type EnvironmentFileType = (typeof EnvironmentFileType)[keyof typeof Envi
40714069
* <p>Windows platform version <code>1.0.0</code> or later.</p>
40724070
* </li>
40734071
* </ul>
4072+
* <p>Consider the following when using the Fargate launch type:</p>
4073+
* <ul>
4074+
* <li>
4075+
* <p>The file is handled like a native Docker env-file.</p>
4076+
* </li>
4077+
* <li>
4078+
* <p>There is no support for shell escape handling.</p>
4079+
* </li>
4080+
* <li>
4081+
* <p>The container entry point interperts the <code>VARIABLE</code> values.</p>
4082+
* </li>
4083+
* </ul>
40744084
*/
40754085
export interface EnvironmentFile {
40764086
/**
@@ -4167,8 +4177,8 @@ export interface FirelensConfiguration {
41674177
* </note>
41684178
* <p>You can view the health status of both individual containers and a task with the
41694179
* DescribeTasks API operation or when viewing the task details in the console.</p>
4170-
* <p>The health check is designed to make sure that your containers survive
4171-
* agent restarts, upgrades, or temporary unavailability.</p>
4180+
* <p>The health check is designed to make sure that your containers survive agent restarts,
4181+
* upgrades, or temporary unavailability.</p>
41724182
* <p>The following describes the possible <code>healthStatus</code> values for a
41734183
* container:</p>
41744184
* <ul>
@@ -4183,30 +4193,78 @@ export interface FirelensConfiguration {
41834193
* </li>
41844194
* <li>
41854195
* <p>
4186-
* <code>UNKNOWN</code>-The container health check is being evaluated or
4187-
* there's no container health check defined.</p>
4196+
* <code>UNKNOWN</code>-The container health check is being evaluated,
4197+
* there's no container health check defined, or Amazon ECS doesn't have the health
4198+
* status of the container.</p>
41884199
* </li>
41894200
* </ul>
4190-
* <p>The following describes the possible <code>healthStatus</code> values for a task. The
4191-
* container health check status of
4192-
* non-essential containers don't have an effect on the health status of a task.</p>
4201+
* <p>The following describes the possible <code>healthStatus</code> values based on the
4202+
* container health checker status of essential containers in the task with the following
4203+
* priority order (high to low):</p>
41934204
* <ul>
41944205
* <li>
41954206
* <p>
4196-
* <code>HEALTHY</code>-All essential containers within the task have
4197-
* passed their health checks.</p>
4207+
* <code>UNHEALTHY</code>-One or more essential containers have failed
4208+
* their health check.</p>
41984209
* </li>
41994210
* <li>
42004211
* <p>
4201-
* <code>UNHEALTHY</code>-One or more essential containers have failed
4202-
* their health check.</p>
4212+
* <code>UNKNOWN</code>-Any essential container running within the task is
4213+
* in an <code>UNKNOWN</code> state and no other essential containers have an
4214+
* <code>UNHEALTHY</code> state.</p>
42034215
* </li>
42044216
* <li>
42054217
* <p>
4206-
* <code>UNKNOWN</code>-The essential containers within the task are still
4207-
* having their health checks evaluated, there are only nonessential containers
4208-
* with health checks defined, or there are no container health checks
4209-
* defined.</p>
4218+
* <code>HEALTHY</code>-All essential containers within the task have
4219+
* passed their health checks.</p>
4220+
* </li>
4221+
* </ul>
4222+
* <p>Consider the following task health example with 2 containers.</p>
4223+
* <ul>
4224+
* <li>
4225+
* <p>If Container1 is <code>UNHEALTHY</code> and Container2 is
4226+
* <code>UNKNOWN</code>, the task health is <code>UNHEALTHY</code>.</p>
4227+
* </li>
4228+
* <li>
4229+
* <p>If Container1 is <code>UNHEALTHY</code> and Container2 is
4230+
* <code>HEALTHY</code>, the task health is <code>UNHEALTHY</code>.</p>
4231+
* </li>
4232+
* <li>
4233+
* <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>UNKNOWN</code>,
4234+
* the task health is <code>UNKNOWN</code>.</p>
4235+
* </li>
4236+
* <li>
4237+
* <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>HEALTHY</code>,
4238+
* the task health is <code>HEALTHY</code>.</p>
4239+
* </li>
4240+
* </ul>
4241+
* <p>Consider the following task health example with 3 containers.</p>
4242+
* <ul>
4243+
* <li>
4244+
* <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3
4245+
* is <code>UNKNOWN</code>, the task health is <code>UNHEALTHY</code>.</p>
4246+
* </li>
4247+
* <li>
4248+
* <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3
4249+
* is <code>HEALTHY</code>, the task health is <code>UNHEALTHY</code>.</p>
4250+
* </li>
4251+
* <li>
4252+
* <p>If Container1 is <code>UNHEALTHY</code> and Container2 is <code>HEALTHY</code>, and Container3
4253+
* is <code>HEALTHY</code>, the task health is <code>UNHEALTHY</code>.</p>
4254+
* </li>
4255+
* <li>
4256+
* <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>UNKNOWN</code>, and Container3
4257+
* is <code>HEALTHY</code>, the task health is <code>UNKNOWN</code>.</p>
4258+
* </li>
4259+
* <li>
4260+
* <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>UNKNOWN</code>,
4261+
* and Container3 is <code>UNKNOWN</code>, the task health is
4262+
* <code>UNKNOWN</code>.</p>
4263+
* </li>
4264+
* <li>
4265+
* <p>If Container1 is <code>HEALTHY</code> and Container2 is <code>HEALTHY</code>,
4266+
* and Container3 is <code>HEALTHY</code>, the task health is
4267+
* <code>HEALTHY</code>.</p>
42104268
* </li>
42114269
* </ul>
42124270
* <p>If a task is run manually, and not as part of a service, the task will continue its
@@ -4216,12 +4274,13 @@ export interface FirelensConfiguration {
42164274
* <p>The following are notes about container health check support:</p>
42174275
* <ul>
42184276
* <li>
4219-
* <p>When the Amazon ECS agent cannot connect to the Amazon ECS service, the
4220-
* service reports the container as <code>UNHEALTHY</code>. </p>
4277+
* <p>When the Amazon ECS agent cannot connect to the Amazon ECS service, the service reports
4278+
* the container as <code>UNHEALTHY</code>. </p>
42214279
* </li>
42224280
* <li>
4223-
* <p>The health check statuses are the "last heard from" response from the Amazon ECS agent. There
4224-
* are no assumptions made about the status of the container health checks.</p>
4281+
* <p>The health check statuses are the "last heard from" response from the Amazon ECS
4282+
* agent. There are no assumptions made about the status of the container health
4283+
* checks.</p>
42254284
* </li>
42264285
* <li>
42274286
* <p>Container health checks require version 1.17.0 or greater of the Amazon ECS
@@ -4725,8 +4784,8 @@ export interface PortMapping {
47254784
* <ul>
47264785
* <li>
47274786
* <p>For containers in a task with the <code>awsvpc</code> network mode,
4728-
* the <code>hostPort</code> is set to the same value as the
4729-
* <code>containerPort</code>. This is a static mapping
4787+
* the <code>hostPortRange</code> is set to the same value as the
4788+
* <code>containerPortRange</code>. This is a static mapping
47304789
* strategy.</p>
47314790
* </li>
47324791
* <li>
@@ -7718,8 +7777,8 @@ export interface NetworkBinding {
77187777
* <ul>
77197778
* <li>
77207779
* <p>For containers in a task with the <code>awsvpc</code> network mode,
7721-
* the <code>hostPort</code> is set to the same value as the
7722-
* <code>containerPort</code>. This is a static mapping
7780+
* the <code>hostPortRange</code> is set to the same value as the
7781+
* <code>containerPortRange</code>. This is a static mapping
77237782
* strategy.</p>
77247783
* </li>
77257784
* <li>

0 commit comments

Comments
 (0)