Set Instance Protection
autoscaling_set_instance_protection | R Documentation |
Updates the instance protection settings of the specified instances¶
Description¶
Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
Usage¶
autoscaling_set_instance_protection(InstanceIds, AutoScalingGroupName,
ProtectedFromScaleIn)
Arguments¶
InstanceIds |
[required] One or more instance IDs. You can specify up to 50 instances. |
AutoScalingGroupName |
[required] The name of the Auto Scaling group. |
ProtectedFromScaleIn |
[required] Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. |
Value¶
An empty list.
Request syntax¶
svc$set_instance_protection(
InstanceIds = list(
"string"
),
AutoScalingGroupName = "string",
ProtectedFromScaleIn = TRUE|FALSE
)
Examples¶
## Not run:
# This example enables instance protection for the specified instance.
svc$set_instance_protection(
AutoScalingGroupName = "my-auto-scaling-group",
InstanceIds = list(
"i-93633f9b"
),
ProtectedFromScaleIn = TRUE
)
# This example disables instance protection for the specified instance.
svc$set_instance_protection(
AutoScalingGroupName = "my-auto-scaling-group",
InstanceIds = list(
"i-93633f9b"
),
ProtectedFromScaleIn = FALSE
)
## End(Not run)