/AWS1/CL_ECS=>UPDATETASKPROTECTION()
¶
About UpdateTaskProtection¶
Updates the protection status of a task. You can set protectionEnabled
to
true
to protect your task from termination during scale-in events from
Service
Autoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the
protectionEnabled
property making the task eligible for termination by
a subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to
2,880 minutes (48 hours). To specify the custom expiration period, set the
expiresInMinutes
property. The expiresInMinutes
property
is always reset when you invoke this operation for a task that already has
protectionEnabled
set to true
. You can keep extending the
protection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .
This operation is only supported for tasks belonging to an Amazon ECS service. Invoking
this operation for a standalone task will result in an TASK_NOT_VALID
failure. For more information, see API failure
reasons.
If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CLUSTER
TYPE /AWS1/ECSSTRING
/AWS1/ECSSTRING
¶
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
IT_TASKS
TYPE /AWS1/CL_ECSSTRINGLIST_W=>TT_STRINGLIST
TT_STRINGLIST
¶
A list of up to 10 task IDs or full ARN entries.
IV_PROTECTIONENABLED
TYPE /AWS1/ECSBOOLEAN
/AWS1/ECSBOOLEAN
¶
Specify
true
to mark a task for protection andfalse
to unset protection, making it eligible for termination.
Optional arguments:¶
IV_EXPIRESINMINUTES
TYPE /AWS1/ECSBOXEDINTEGER
/AWS1/ECSBOXEDINTEGER
¶
If you set
protectionEnabled
totrue
, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses,protectionEnabled
will be reset tofalse
.If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).