Skip to content

Commit f1513dc

Browse files
author
awstools
committed
docs(client-ecs): This release is a documentation only update to address customer issues.
1 parent 900da98 commit f1513dc

File tree

2 files changed

+54
-50
lines changed

2 files changed

+54
-50
lines changed

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

Lines changed: 46 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1580,6 +1580,8 @@ export interface LoadBalancer {
15801580
* @public
15811581
* <p>The name of the container (as it appears in a container definition) to associate with
15821582
* the load balancer.</p>
1583+
* <p>You need to specify the container name when configuring the target group for an Amazon ECS
1584+
* load balancer.</p>
15831585
*/
15841586
containerName?: string;
15851587

@@ -2603,7 +2605,7 @@ export interface CreateServiceRequest {
26032605
* infrastructure.</p>
26042606
* <note>
26052607
* <p>Fargate Spot infrastructure is available for use but a capacity provider
2606-
* strategy must be used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-capacity-providers.html">Fargate capacity providers</a> in the
2608+
* strategy must be used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html">Fargate capacity providers</a> in the
26072609
* <i>Amazon ECS User Guide for Fargate</i>.</p>
26082610
* </note>
26092611
* <p>The <code>EC2</code> launch type runs your tasks on Amazon EC2 instances registered to your
@@ -5310,27 +5312,49 @@ export interface ResourceRequirement {
53105312
/**
53115313
* @public
53125314
* <p>A list of namespaced kernel parameters to set in the container. This parameter maps to
5313-
* <code>Sysctls</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
5314-
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--sysctl</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>.</p>
5315+
* <code>Sysctls</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
5316+
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--sysctl</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>. For example, you can configure
5317+
* <code>net.ipv4.tcp_keepalive_time</code> setting to maintain longer lived
5318+
* connections.</p>
53155319
* <p>We don't recommend that you specify network-related <code>systemControls</code>
5316-
* parameters for multiple containers in a single task. This task also uses either the
5317-
* <code>awsvpc</code> or <code>host</code> network mode. It does it for the following
5318-
* reasons.</p>
5320+
* parameters for multiple containers in a single task that also uses either the
5321+
* <code>awsvpc</code> or <code>host</code> network mode. Doing this has the following
5322+
* disadvantages:</p>
53195323
* <ul>
53205324
* <li>
5321-
* <p>For tasks that use the <code>awsvpc</code> network mode, if you set
5322-
* <code>systemControls</code> for any container, it applies to all containers
5323-
* in the task. If you set different <code>systemControls</code> for multiple
5324-
* containers in a single task, the container that's started last determines which
5325-
* <code>systemControls</code> take effect.</p>
5325+
* <p>For tasks that use the <code>awsvpc</code> network mode including Fargate,
5326+
* if you set <code>systemControls</code> for any container, it applies to all
5327+
* containers in the task. If you set different <code>systemControls</code> for
5328+
* multiple containers in a single task, the container that's started last
5329+
* determines which <code>systemControls</code> take effect.</p>
53265330
* </li>
53275331
* <li>
5328-
* <p>For tasks that use the <code>host</code> network mode, the
5329-
* <code>systemControls</code> parameter applies to the container instance's
5330-
* kernel parameter and that of all containers of any tasks running on that
5331-
* container instance.</p>
5332+
* <p>For tasks that use the <code>host</code> network mode, the network namespace
5333+
* <code>systemControls</code> aren't supported.</p>
53325334
* </li>
53335335
* </ul>
5336+
* <p>If you're setting an IPC resource namespace to use for the containers in the task, the
5337+
* following conditions apply to your system controls. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode">IPC mode</a>.</p>
5338+
* <ul>
5339+
* <li>
5340+
* <p>For tasks that use the <code>host</code> IPC mode, IPC namespace
5341+
* <code>systemControls</code> aren't supported.</p>
5342+
* </li>
5343+
* <li>
5344+
* <p>For tasks that use the <code>task</code> IPC mode, IPC namespace
5345+
* <code>systemControls</code> values apply to all containers within a
5346+
* task.</p>
5347+
* </li>
5348+
* </ul>
5349+
* <note>
5350+
* <p>This parameter is not supported for Windows containers.</p>
5351+
* </note>
5352+
* <note>
5353+
* <p>This parameter is only supported for tasks that are hosted on
5354+
* Fargate if the tasks are using platform version <code>1.4.0</code> or later
5355+
* (Linux). This isn't supported for Windows containers on
5356+
* Fargate.</p>
5357+
* </note>
53345358
*/
53355359
export interface SystemControl {
53365360
/**
@@ -6131,28 +6155,10 @@ export interface ContainerDefinition {
61316155
/**
61326156
* @public
61336157
* <p>A list of namespaced kernel parameters to set in the container. This parameter maps to
6134-
* <code>Sysctls</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
6158+
* <code>Sysctls</code> in the <a href="https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate">Create a container</a> section of the
61356159
* <a href="https://docs.docker.com/engine/api/v1.35/">Docker Remote API</a> and the <code>--sysctl</code> option to <a href="https://docs.docker.com/engine/reference/run/#security-configuration">docker run</a>. For example, you can configure
6136-
* <code>net.ipv4.tcp_keepalive_time</code> setting to maintain longer lived
6160+
* <code>net.ipv4.tcp_keepalive_time</code> setting to maintain longer lived
61376161
* connections.</p>
6138-
* <note>
6139-
* <p>We don't recommended that you specify network-related <code>systemControls</code>
6140-
* parameters for multiple containers in a single task that also uses either the
6141-
* <code>awsvpc</code> or <code>host</code> network modes. For tasks that use the
6142-
* <code>awsvpc</code> network mode, the container that's started last determines
6143-
* which <code>systemControls</code> parameters take effect. For tasks that use the
6144-
* <code>host</code> network mode, it changes the container instance's namespaced
6145-
* kernel parameters as well as the containers.</p>
6146-
* </note>
6147-
* <note>
6148-
* <p>This parameter is not supported for Windows containers.</p>
6149-
* </note>
6150-
* <note>
6151-
* <p>This parameter is only supported for tasks that are hosted on
6152-
* Fargate if the tasks are using platform version <code>1.4.0</code> or later
6153-
* (Linux). This isn't supported for Windows containers on
6154-
* Fargate.</p>
6155-
* </note>
61566162
*/
61576163
systemControls?: SystemControl[];
61586164

@@ -6215,8 +6221,7 @@ export interface ContainerDefinition {
62156221
* @public
62166222
* <p>The amount of ephemeral storage to allocate for the task. This parameter is used to
62176223
* expand the total amount of ephemeral storage available, beyond the default amount, for
6218-
* tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html">Fargate task
6219-
* storage</a> in the <i>Amazon ECS User Guide for Fargate</i>.</p>
6224+
* tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html">Using data volumes in tasks</a> in the <i>Amazon ECS Developer Guide;</i>.</p>
62206225
* <note>
62216226
* <p>For tasks using the Fargate launch type, the task requires the
62226227
* following platforms:</p>
@@ -8849,7 +8854,7 @@ export interface Task {
88498854
* @public
88508855
* <p>The stop code indicating why a task was stopped. The <code>stoppedReason</code> might
88518856
* contain additional details. </p>
8852-
* <p>For more information about stop code, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/stopped-task-error-codes.html">Stopped tasks error codes</a> in the <i>Amazon ECS User Guide</i>.</p>
8857+
* <p>For more information about stop code, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/stopped-task-error-codes.html">Stopped tasks error codes</a> in the <i>Amazon ECS Developer Guide</i>.</p>
88538858
*/
88548859
stopCode?: TaskStopCode;
88558860

@@ -10858,8 +10863,7 @@ export interface RegisterTaskDefinitionRequest {
1085810863
* @public
1085910864
* <p>The amount of ephemeral storage to allocate for the task. This parameter is used to
1086010865
* expand the total amount of ephemeral storage available, beyond the default amount, for
10861-
* tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html">Fargate task
10862-
* storage</a> in the <i>Amazon ECS User Guide for Fargate</i>.</p>
10866+
* tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html">Using data volumes in tasks</a> in the <i>Amazon ECS Developer Guide</i>.</p>
1086310867
* <note>
1086410868
* <p>For tasks using the Fargate launch type, the task requires the
1086510869
* following platforms:</p>
@@ -11248,8 +11252,8 @@ export interface RunTaskRequest {
1124811252
* infrastructure.</p>
1124911253
* <note>
1125011254
* <p>Fargate Spot infrastructure is available for use but a capacity provider
11251-
* strategy must be used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/fargate-capacity-providers.html">Fargate capacity providers</a> in the
11252-
* <i>Amazon ECS User Guide for Fargate</i>.</p>
11255+
* strategy must be used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html">Fargate capacity providers</a> in the
11256+
* <i>Amazon ECS Developer Guide</i>.</p>
1125311257
* </note>
1125411258
* <p>The <code>EC2</code> launch type runs your tasks on Amazon EC2 instances registered to your
1125511259
* cluster.</p>

0 commit comments

Comments
 (0)