autoscaling_set_instance_protection: Updates the instance protection settings of the specified...

Description Usage Arguments Value Request syntax Examples

View source: R/autoscaling_operations.R

Description

Updates the instance protection settings of the specified instances.

For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see 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

1
2
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

1
2
3
4
5
6
7
svc$set_instance_protection(
  InstanceIds = list(
    "string"
  ),
  AutoScalingGroupName = "string",
  ProtectedFromScaleIn = TRUE|FALSE
)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
## 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)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.