UpdateZonalAutoshiftConfiguration - Amazon Route 53 Application Recovery Controller

UpdateZonalAutoshiftConfiguration

The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.

You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is ENABLED, you authorize AWS to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.

Request Syntax

PUT /managedresources/resourceIdentifier HTTP/1.1 Content-type: application/json { "zonalAutoshiftStatus": "string" }

URI Request Parameters

The request uses the following URI parameters.

resourceIdentifier

The identifier for the resource that you want to update the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

Length Constraints: Minimum length of 8. Maximum length of 1024.

Required: Yes

Request Body

The request accepts the following data in JSON format.

zonalAutoshiftStatus

The zonal autoshift status for the resource that you want to update the zonal autoshift configuration for. Choose ENABLED to authorize AWS to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "resourceIdentifier": "string", "zonalAutoshiftStatus": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

resourceIdentifier

The identifier for the resource that you updated the zonal autoshift configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 1024.

zonalAutoshiftStatus

The updated zonal autoshift status for the resource.

Type: String

Valid Values: ENABLED | DISABLED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be processed because of conflict in the current state of the resource.

HTTP Status Code: 409

InternalServerException

There was an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The input requested a resource that was not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: