Skip to content

Commit 8946a54

Browse files
author
awstools
committed
feat(client-ecs): This release adds support for an account-level setting that you can use to configure the number of days for AWS Fargate task retirement.
1 parent 185a231 commit 8946a54

File tree

6 files changed

+188
-86
lines changed

6 files changed

+188
-86
lines changed

clients/client-ecs/src/commands/DeleteAccountSettingCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ export interface DeleteAccountSettingCommandOutput extends DeleteAccountSettingR
4545
* // const { ECSClient, DeleteAccountSettingCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
4646
* const client = new ECSClient(config);
4747
* const input = { // DeleteAccountSettingRequest
48-
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization", // required
48+
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization" || "fargateTaskRetirementWaitPeriod", // required
4949
* principalArn: "STRING_VALUE",
5050
* };
5151
* const command = new DeleteAccountSettingCommand(input);
5252
* const response = await client.send(command);
5353
* // { // DeleteAccountSettingResponse
5454
* // setting: { // Setting
55-
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization",
55+
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization" || "fargateTaskRetirementWaitPeriod",
5656
* // value: "STRING_VALUE",
5757
* // principalArn: "STRING_VALUE",
5858
* // },

clients/client-ecs/src/commands/ListAccountSettingsCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface ListAccountSettingsCommandOutput extends ListAccountSettingsRes
4444
* // const { ECSClient, ListAccountSettingsCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
4545
* const client = new ECSClient(config);
4646
* const input = { // ListAccountSettingsRequest
47-
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization",
47+
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization" || "fargateTaskRetirementWaitPeriod",
4848
* value: "STRING_VALUE",
4949
* principalArn: "STRING_VALUE",
5050
* effectiveSettings: true || false,
@@ -56,7 +56,7 @@ export interface ListAccountSettingsCommandOutput extends ListAccountSettingsRes
5656
* // { // ListAccountSettingsResponse
5757
* // settings: [ // Settings
5858
* // { // Setting
59-
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization",
59+
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization" || "fargateTaskRetirementWaitPeriod",
6060
* // value: "STRING_VALUE",
6161
* // principalArn: "STRING_VALUE",
6262
* // },

clients/client-ecs/src/commands/PutAccountSettingCommand.ts

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,20 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
4141
* and roles that do not have specified individual account settings. For more information,
4242
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account
4343
* Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
44-
* <p>When <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or
45-
* <code>containerInstanceLongArnFormat</code> are specified, the Amazon Resource Name
46-
* (ARN) and resource ID format of the resource type for a specified user, role, or
47-
* the root user for an account is affected. The opt-in and opt-out account setting must be
48-
* set for each Amazon ECS resource separately. The ARN and resource ID format of a resource
49-
* is defined by the opt-in status of the user or role that created the resource. You
50-
* must turn on this setting to use Amazon ECS features such as resource tagging.</p>
51-
* <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI)
52-
* limit for any new container instances that support the feature is changed. If
53-
* <code>awsvpcTrunking</code> is turned on, any new container instances that support the
54-
* feature are launched have the increased ENI limits available to them. For more
44+
* <p>When you specify <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or
45+
* <code>containerInstanceLongArnFormat</code>, the Amazon Resource Name (ARN) and
46+
* resource ID format of the resource type for a specified user, role, or the root user for an
47+
* account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS
48+
* resource separately. The ARN and resource ID format of a resource is defined by the
49+
* opt-in status of the user or role that created the resource. You must turn on this
50+
* setting to use Amazon ECS features such as resource tagging.</p>
51+
* <p>When you specify <code>awsvpcTrunking</code>, the elastic network interface (ENI) limit for
52+
* any new container instances that support the feature is changed. If
53+
* <code>awsvpcTrunking</code> is turned on, any new container instances that support
54+
* the feature are launched have the increased ENI limits available to them. For more
5555
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html">Elastic Network
5656
* Interface Trunking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
57-
* <p>When <code>containerInsights</code> is specified, the default setting indicating whether
57+
* <p>When you specify <code>containerInsights</code>, the default setting indicating whether
5858
* Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If
5959
* <code>containerInsights</code> is turned on, any new clusters that are created will
6060
* have Container Insights turned on unless you disable it during cluster creation. For
@@ -68,22 +68,27 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
6868
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html">Grant
6969
* permission to tag resources on creation</a> in the <i>Amazon ECS Developer
7070
* Guide</i>.</p>
71+
* <p>When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS
72+
* task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace
73+
* them. Use <code>fargateTaskRetirementWaitPeriod</code> to configure the wait time to
74+
* retire a Fargate task. For information about the Fargate tasks maintenance, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html">Amazon Web Services Fargate task maintenance</a> in the <i>Amazon ECS Developer
75+
* Guide</i>.</p>
7176
* @example
7277
* Use a bare-bones client and the command you need to make an API call.
7378
* ```javascript
7479
* import { ECSClient, PutAccountSettingCommand } from "@aws-sdk/client-ecs"; // ES Modules import
7580
* // const { ECSClient, PutAccountSettingCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
7681
* const client = new ECSClient(config);
7782
* const input = { // PutAccountSettingRequest
78-
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization", // required
83+
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization" || "fargateTaskRetirementWaitPeriod", // required
7984
* value: "STRING_VALUE", // required
8085
* principalArn: "STRING_VALUE",
8186
* };
8287
* const command = new PutAccountSettingCommand(input);
8388
* const response = await client.send(command);
8489
* // { // PutAccountSettingResponse
8590
* // setting: { // Setting
86-
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization",
91+
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization" || "fargateTaskRetirementWaitPeriod",
8792
* // value: "STRING_VALUE",
8893
* // principalArn: "STRING_VALUE",
8994
* // },

clients/client-ecs/src/commands/PutAccountSettingDefaultCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@ export interface PutAccountSettingDefaultCommandOutput extends PutAccountSetting
4646
* // const { ECSClient, PutAccountSettingDefaultCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
4747
* const client = new ECSClient(config);
4848
* const input = { // PutAccountSettingDefaultRequest
49-
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization", // required
49+
* name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization" || "fargateTaskRetirementWaitPeriod", // required
5050
* value: "STRING_VALUE", // required
5151
* };
5252
* const command = new PutAccountSettingDefaultCommand(input);
5353
* const response = await client.send(command);
5454
* // { // PutAccountSettingDefaultResponse
5555
* // setting: { // Setting
56-
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization",
56+
* // name: "serviceLongArnFormat" || "taskLongArnFormat" || "containerInstanceLongArnFormat" || "awsvpcTrunking" || "containerInsights" || "fargateFIPSMode" || "tagResourceAuthorization" || "fargateTaskRetirementWaitPeriod",
5757
* // value: "STRING_VALUE",
5858
* // principalArn: "STRING_VALUE",
5959
* // },

0 commit comments

Comments
 (0)