CreateRoutingControl, UpdateRoutingControl - Amazon Route 53 Application Recovery Controller

CreateRoutingControl, UpdateRoutingControl

URI

/routingcontrol

HTTP methods

POST

Operation ID: CreateRoutingControl

Creates a new routing control.

A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Responses
Status code Response model Description
200 CreateRoutingControlResponse

200 response - Success.

400 ValidationException

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

402 ServiceQuotaExceededException

402 response

403 AccessDeniedException

403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

404 ResourceNotFoundException

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

409 ConflictException

409 response - ConflictException. You might be using a predefined variable.

429 ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500 InternalServerException

500 response - InternalServiceError. Temporary service error. Retry the request.

PUT

Operation ID: UpdateRoutingControl

Updates a routing control. You can only update the name of the routing control. To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

Responses
Status code Response model Description
200 UpdateRoutingControlResponse

200 response - Success.

400 ValidationException

400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.

403 AccessDeniedException

403 response - AccessDeniedException. You do not hace sufficient access to perform this action.

404 ResourceNotFoundException

404 response - MalformedQueryString. The query string contains a syntax error or resource not found.

409 ConflictException

409 response - ConflictException. You might be using a predefined variable.

429 ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500 InternalServerException

500 response - InternalServiceError. Temporary service error. Retry the request.

OPTIONS

Responses
Status code Response model Description
200 None

200 response - Success.

Schemas

Request bodies

{ "ClusterArn": "string", "RoutingControlName": "string", "ControlPanelArn": "string", "ClientToken": "string" }
{ "RoutingControlName": "string", "RoutingControlArn": "string" }

Response bodies

{ "RoutingControl": { "Status": enum, "RoutingControlArn": "string", "ControlPanelArn": "string", "Name": "string" } }
{ "RoutingControl": { "Status": enum, "RoutingControlArn": "string", "ControlPanelArn": "string", "Name": "string" } }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }

Properties

AccessDeniedException

Property Type Required Description
message

string

True

ConflictException

Property Type Required Description
message

string

True

CreateRoutingControlRequest

A request to create a routing control. If you don't specify ControlPanelArn, Amazon Route 53 Application Recovery Controller creates the routing control in DefaultControlPanel.

Property Type Required Description
ClientToken

string

MaxLength: 64

False
ClusterArn

string

True

The Amazon Resource Name (ARN) of the cluster that includes the routing control.

ControlPanelArn

string

False

The Amazon Resource Name (ARN) of the control panel that includes the routing control.

RoutingControlName

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

True

The name of the routing control.

CreateRoutingControlResponse

The result of a successful CreateRoutingControl request.

Property Type Required Description
RoutingControl

RoutingControl

False

The routing control that is created.

InternalServerException

Property Type Required Description
message

string

True

ResourceNotFoundException

Property Type Required Description
message

string

True

RoutingControl

A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

Property Type Required Description
ControlPanelArn

string

False

The Amazon Resource Name (ARN) of the control panel that includes the routing control.

Name

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

False

The name of the routing control.

RoutingControlArn

string

False

The Amazon Resource Name (ARN) of the routing control.

Status

Status

False

The deployment status of a routing control. Status can be one of the following: PENDING, DEPLOYED, PENDING_DELETION.

ServiceQuotaExceededException

Property Type Required Description
message

string

True

Status

The deployment status of a resource. Status can be one of the following:

PENDING: Amazon Route 53 Application Recovery Controller is creating the resource.

DEPLOYED: The resource is deployed and ready to use.

PENDING_DELETION: Amazon Route 53 Application Recovery Controller is deleting the resource.

  • PENDING

  • DEPLOYED

  • PENDING_DELETION

ThrottlingException

Property Type Required Description
message

string

True

UpdateRoutingControlRequest

A request to update a routing control.

Property Type Required Description
RoutingControlArn

string

True

The Amazon Resource Name (ARN) of the routing control.

RoutingControlName

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

True

The name of the routing control.

UpdateRoutingControlResponse

The result of a successful UpdateRoutingControl request.

Property Type Required Description
RoutingControl

RoutingControl

True

The routing control that was updated.

ValidationException

Property Type Required Description
message

string

True

See also

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

CreateRoutingControl

UpdateRoutingControl