ecs_update_task_protection: Updates the protection status of a task

View source: R/ecs_operations.R

ecs_update_task_protectionR Documentation

Updates the protection status of a task

Description

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.

See https://www.paws-r-sdk.com/docs/ecs_update_task_protection/ for full documentation.

Usage

ecs_update_task_protection(
  cluster,
  tasks,
  protectionEnabled,
  expiresInMinutes = NULL
)

Arguments

cluster

[required] The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

tasks

[required] A list of up to 10 task IDs or full ARN entries.

protectionEnabled

[required] Specify true to mark a task for protection and false to unset protection, making it eligible for termination.

expiresInMinutes

If you set protectionEnabled to true, 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 to false.

If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).


paws.compute documentation built on Sept. 12, 2024, 6:12 a.m.