View a markdown version of this page

Use SetInstanceHealth with a CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use SetInstanceHealth with a CLI

The following code examples show how to use SetInstanceHealth.

CLI
AWS CLI

To set the health status of an instance

The following set-instance-health example sets the health status of the specified instance to Unhealthy.

aws autoscaling set-instance-health \ --instance-id i-061c63c5eb45f0416 \ --health-status Unhealthy

This command produces no output.

For more information, see Set up a custom health check for your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

PowerShell
Tools for PowerShell V4

Example 1: This example sets the status of the specified instance to 'Unhealthy', taking it out of service. Auto Scaling terminates and replaces the instance.

Set-ASInstanceHealth -HealthStatus Unhealthy -InstanceId i-93633f9b

Example 2: This example sets the status of the specified instance to 'Healthy', keeping it in service. Any health check grace period for the Auto Scaling group is not honored.

Set-ASInstanceHealth -HealthStatus Healthy -InstanceId i-93633f9b -ShouldRespectGracePeriod $false
  • For API details, see SetInstanceHealth in AWS Tools for PowerShell Cmdlet Reference (V4).

Tools for PowerShell V5

Example 1: This example sets the status of the specified instance to 'Unhealthy', taking it out of service. Auto Scaling terminates and replaces the instance.

Set-ASInstanceHealth -HealthStatus Unhealthy -InstanceId i-93633f9b

Example 2: This example sets the status of the specified instance to 'Healthy', keeping it in service. Any health check grace period for the Auto Scaling group is not honored.

Set-ASInstanceHealth -HealthStatus Healthy -InstanceId i-93633f9b -ShouldRespectGracePeriod $false
  • For API details, see SetInstanceHealth in AWS Tools for PowerShell Cmdlet Reference (V5).