AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the SetInstanceProtection operation. Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.AutoScaling.AmazonAutoScalingRequest
      Amazon.AutoScaling.Model.SetInstanceProtectionRequest

Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

C#
public class SetInstanceProtectionRequest : AmazonAutoScalingRequest
         IAmazonWebServiceRequest

The SetInstanceProtectionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

The name of the Auto Scaling group.

Public Property InstanceIds System.Collections.Generic.List<System.String>

Gets and sets the property InstanceIds.

One or more instance IDs. You can specify up to 50 instances.

Public Property ProtectedFromScaleIn System.Boolean

Gets and sets the property ProtectedFromScaleIn.

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

Examples

This example enables instance protection for the specified instance.

To enable instance protection for an instance


var client = new AmazonAutoScalingClient();
var response = client.SetInstanceProtection(new SetInstanceProtectionRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    InstanceIds = new List<string> {
        "i-93633f9b"
    },
    ProtectedFromScaleIn = true
});


            

This example disables instance protection for the specified instance.

To disable instance protection for an instance


var client = new AmazonAutoScalingClient();
var response = client.SetInstanceProtection(new SetInstanceProtectionRequest 
{
    AutoScalingGroupName = "my-auto-scaling-group",
    InstanceIds = new List<string> {
        "i-93633f9b"
    },
    ProtectedFromScaleIn = false
});


            

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5