Skip to content

Commit fbbf19a

Browse files
author
awstools
committed
docs(client-ecs): Documentation only release for Amazon ECS.
1 parent 25f581e commit fbbf19a

File tree

2 files changed

+11
-100
lines changed

2 files changed

+11
-100
lines changed

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

Lines changed: 8 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -7442,35 +7442,8 @@ export interface TaskDefinition {
74427442
* <p>If you're using the EC2 launch type or the external launch type, this
74437443
* field is optional. Supported values are between <code>128</code> CPU units
74447444
* (<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code>
7445-
* vCPUs). The CPU units cannot be less than 1 vCPU when you use Windows containers on
7446-
* Fargate.</p>
7447-
* <ul>
7448-
* <li>
7449-
* <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>
7450-
* </li>
7451-
* <li>
7452-
* <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p>
7453-
* </li>
7454-
* <li>
7455-
* <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p>
7456-
* </li>
7457-
* <li>
7458-
* <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p>
7459-
* </li>
7460-
* <li>
7461-
* <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p>
7462-
* </li>
7463-
* <li>
7464-
* <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p>
7465-
* <p>This option requires Linux platform <code>1.4.0</code> or
7466-
* later.</p>
7467-
* </li>
7468-
* <li>
7469-
* <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p>
7470-
* <p>This option requires Linux platform <code>1.4.0</code> or
7471-
* later.</p>
7472-
* </li>
7473-
* </ul>
7445+
* vCPUs). </p>
7446+
* <p>This field is required for Fargate. For information about the valid values, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size">Task size</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
74747447
* @public
74757448
*/
74767449
cpu?: string | undefined;
@@ -9608,42 +9581,11 @@ export interface Task {
96089581
* expressed as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1
96099582
* vcpu</code>). String values are converted to an integer that indicates the CPU units
96109583
* when the task definition is registered.</p>
9611-
* <p>If you're using the EC2 launch type or the external launch type, this
9612-
* field is optional. Supported values are between <code>128</code> CPU units
9613-
* (<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code>
9614-
* vCPUs). If you do not specify a value, the parameter is ignored.</p>
9615-
* <p>If you're using the Fargate launch type, this field is required. You
9616-
* must use one of the following values. These values determine the range of supported
9617-
* values for the <code>memory</code> parameter:</p>
9618-
* <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on
9619-
* Fargate.</p>
9620-
* <ul>
9621-
* <li>
9622-
* <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>
9623-
* </li>
9624-
* <li>
9625-
* <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p>
9626-
* </li>
9627-
* <li>
9628-
* <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p>
9629-
* </li>
9630-
* <li>
9631-
* <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p>
9632-
* </li>
9633-
* <li>
9634-
* <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p>
9635-
* </li>
9636-
* <li>
9637-
* <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p>
9638-
* <p>This option requires Linux platform <code>1.4.0</code> or
9639-
* later.</p>
9640-
* </li>
9641-
* <li>
9642-
* <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p>
9643-
* <p>This option requires Linux platform <code>1.4.0</code> or
9644-
* later.</p>
9645-
* </li>
9646-
* </ul>
9584+
* <p>If you're using the EC2 launch type or the external launch type, this field is
9585+
* optional. Supported values are between <code>128</code> CPU units (<code>0.125</code>
9586+
* vCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). If you do not specify
9587+
* a value, the parameter is ignored.</p>
9588+
* <p>This field is required for Fargate. For information about the valid values, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size">Task size</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
96479589
* @public
96489590
*/
96499591
cpu?: string | undefined;
@@ -11987,38 +11929,7 @@ export interface RegisterTaskDefinitionRequest {
1198711929
* is optional. Supported values are between <code>128</code> CPU units (<code>0.125</code>
1198811930
* vCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). If you do not specify
1198911931
* a value, the parameter is ignored.</p>
11990-
* <p>If you're using the Fargate launch type, this field is required and you
11991-
* must use one of the following values, which determines your range of supported values
11992-
* for the <code>memory</code> parameter:</p>
11993-
* <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on
11994-
* Fargate.</p>
11995-
* <ul>
11996-
* <li>
11997-
* <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>
11998-
* </li>
11999-
* <li>
12000-
* <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p>
12001-
* </li>
12002-
* <li>
12003-
* <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p>
12004-
* </li>
12005-
* <li>
12006-
* <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p>
12007-
* </li>
12008-
* <li>
12009-
* <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p>
12010-
* </li>
12011-
* <li>
12012-
* <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p>
12013-
* <p>This option requires Linux platform <code>1.4.0</code> or
12014-
* later.</p>
12015-
* </li>
12016-
* <li>
12017-
* <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p>
12018-
* <p>This option requires Linux platform <code>1.4.0</code> or
12019-
* later.</p>
12020-
* </li>
12021-
* </ul>
11932+
* <p>This field is required for Fargate. For information about the valid values, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size">Task size</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
1202211933
* @public
1202311934
*/
1202411935
cpu?: string | undefined;

‎codegen/sdk-codegen/aws-models/ecs.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10224,7 +10224,7 @@
1022410224
"cpu": {
1022510225
"target": "com.amazonaws.ecs#String",
1022610226
"traits": {
10227-
"smithy.api#documentation": "<p>The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, <code>1024</code>) or as a string using vCPUs (for example, <code>1\n\t\t\t\tvCPU</code> or <code>1 vcpu</code>) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.</p>\n <note>\n <p>Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.</p>\n </note>\n <p>If you're using the EC2 launch type or external launch type, this field\n\t\t\tis optional. Supported values are between <code>128</code> CPU units (<code>0.125</code>\n\t\t\tvCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). If you do not specify\n\t\t\ta value, the parameter is ignored.</p>\n <p>If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the <code>memory</code> parameter:</p>\n <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.</p>\n <ul>\n <li>\n <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>\n </li>\n <li>\n <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p>\n </li>\n <li>\n <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p>\n </li>\n <li>\n <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p>\n </li>\n <li>\n <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p>\n </li>\n <li>\n <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p>\n <p>This option requires Linux platform <code>1.4.0</code> or\n later.</p>\n </li>\n <li>\n <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p>\n <p>This option requires Linux platform <code>1.4.0</code> or\n later.</p>\n </li>\n </ul>"
10227+
"smithy.api#documentation": "<p>The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, <code>1024</code>) or as a string using vCPUs (for example, <code>1\n\t\t\t\tvCPU</code> or <code>1 vcpu</code>) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.</p>\n <note>\n <p>Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.</p>\n </note>\n <p>If you're using the EC2 launch type or external launch type, this field\n\t\t\tis optional. Supported values are between <code>128</code> CPU units (<code>0.125</code>\n\t\t\tvCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). If you do not specify\n\t\t\ta value, the parameter is ignored.</p>\n <p>This field is required for Fargate. For information about the valid values, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size\">Task size</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1022810228
}
1022910229
},
1023010230
"memory": {
@@ -13081,7 +13081,7 @@
1308113081
"cpu": {
1308213082
"target": "com.amazonaws.ecs#String",
1308313083
"traits": {
13084-
"smithy.api#documentation": "<p>The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units (for example, <code>1024</code>). It can also be\n\t\t\texpressed as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1\n\t\t\t\tvcpu</code>). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.</p>\n <p>If you're using the EC2 launch type or the external launch type, this\n\t\t\tfield is optional. Supported values are between <code>128</code> CPU units\n\t\t\t\t(<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code>\n\t\t\tvCPUs). If you do not specify a value, the parameter is ignored.</p>\n <p>If you're using the Fargate launch type, this field is required. You\n\t\t\tmust use one of the following values. These values determine the range of supported\n\t\t\tvalues for the <code>memory</code> parameter:</p>\n <p>The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.</p>\n <ul>\n <li>\n <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>\n </li>\n <li>\n <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p>\n </li>\n <li>\n <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p>\n </li>\n <li>\n <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p>\n </li>\n <li>\n <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p>\n </li>\n <li>\n <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p>\n <p>This option requires Linux platform <code>1.4.0</code> or\n later.</p>\n </li>\n <li>\n <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p>\n <p>This option requires Linux platform <code>1.4.0</code> or\n later.</p>\n </li>\n </ul>"
13084+
"smithy.api#documentation": "<p>The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units (for example, <code>1024</code>). It can also be\n\t\t\texpressed as a string using vCPUs (for example, <code>1 vCPU</code> or <code>1\n\t\t\t\tvcpu</code>). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.</p>\n <p>If you're using the EC2 launch type or the external launch type, this field is\n\t\t\toptional. Supported values are between <code>128</code> CPU units (<code>0.125</code>\n\t\t\tvCPUs) and <code>196608</code> CPU units (<code>192</code> vCPUs). If you do not specify\n\t\t\ta value, the parameter is ignored.</p>\n <p>This field is required for Fargate. For information about the valid values, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size\">Task size</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1308513085
}
1308613086
},
1308713087
"createdAt": {
@@ -13344,7 +13344,7 @@
1334413344
"cpu": {
1334513345
"target": "com.amazonaws.ecs#String",
1334613346
"traits": {
13347-
"smithy.api#documentation": "<p>The number of <code>cpu</code> units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the <code>memory</code> parameter.</p>\n <p>If you're using the EC2 launch type or the external launch type, this\n\t\t\tfield is optional. Supported values are between <code>128</code> CPU units\n\t\t\t\t(<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code>\n\t\t\tvCPUs). The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.</p>\n <ul>\n <li>\n <p>256 (.25 vCPU) - Available <code>memory</code> values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)</p>\n </li>\n <li>\n <p>512 (.5 vCPU) - Available <code>memory</code> values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)</p>\n </li>\n <li>\n <p>1024 (1 vCPU) - Available <code>memory</code> values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)</p>\n </li>\n <li>\n <p>2048 (2 vCPU) - Available <code>memory</code> values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)</p>\n </li>\n <li>\n <p>4096 (4 vCPU) - Available <code>memory</code> values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)</p>\n </li>\n <li>\n <p>8192 (8 vCPU) - Available <code>memory</code> values: 16 GB and 60 GB in 4 GB increments</p>\n <p>This option requires Linux platform <code>1.4.0</code> or\n later.</p>\n </li>\n <li>\n <p>16384 (16vCPU) - Available <code>memory</code> values: 32GB and 120 GB in 8 GB increments</p>\n <p>This option requires Linux platform <code>1.4.0</code> or\n later.</p>\n </li>\n </ul>"
13347+
"smithy.api#documentation": "<p>The number of <code>cpu</code> units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the <code>memory</code> parameter.</p>\n <p>If you're using the EC2 launch type or the external launch type, this\n\t\t\tfield is optional. Supported values are between <code>128</code> CPU units\n\t\t\t\t(<code>0.125</code> vCPUs) and <code>196608</code> CPU units (<code>192</code>\n\t\t\tvCPUs). </p>\n <p>This field is required for Fargate. For information about the valid values, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size\">Task size</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
1334813348
}
1334913349
},
1335013350
"memory": {

0 commit comments

Comments
 (0)