Update Instance Custom Health Status

servicediscovery_update_instance_custom_health_status

R Documentation

Submits a request to change the health status of a custom health check to healthy or unhealthy¶

Description¶

Submits a request to change the health status of a custom health check to healthy or unhealthy.

You can use update_instance_custom_health_status to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig.

For more information, see HealthCheckCustomConfig.

Usage¶

servicediscovery_update_instance_custom_health_status(ServiceId,
  InstanceId, Status)

Arguments¶

ServiceId

[required] The ID or Amazon Resource Name (ARN) of the service that includes the configuration for the custom health check that you want to change the status for. For services created in a shared namespace, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

InstanceId

[required] The ID of the instance that you want to change the health status for.

Status

[required] The new status of the instance, HEALTHY or UNHEALTHY.

Value¶

An empty list.

Request syntax¶

svc$update_instance_custom_health_status(
  ServiceId = "string",
  InstanceId = "string",
  Status = "HEALTHY"|"UNHEALTHY"
)

Examples¶

## Not run: 
# This example submits a request to change the health status of an
# instance associated with a service with a custom health check to
# HEALTHY.
svc$update_instance_custom_health_status(
  InstanceId = "i-abcd1234",
  ServiceId = "srv-e4anhexample0004",
  Status = "HEALTHY"
)

## End(Not run)