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 configure routing controls so they update Amazon Route 53 health checks, which reroute traffic for your application.

Note that a routing control name must be unique within a control panel.

To get or update the routing control state, see the GetRoutingControlState API in the Routing Control (Recovery Cluster) API Reference Guide 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 have 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. The name must be unique within a control panel. To get or update the routing control state, see the GetRoutingControlState API in the Routing Control (Recovery Cluster) API Reference Guide 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 have 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

POST schema

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

PUT schema

{
  "RoutingControlName": "string",
  "RoutingControlArn": "string"
}

Response bodies

CreateRoutingControlResponse schema

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

UpdateRoutingControlResponse schema

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

ValidationException schema

{
  "message": "string"
}

ServiceQuotaExceededException schema

{
  "message": "string"
}

AccessDeniedException schema

{
  "message": "string"
}

ResourceNotFoundException schema

{
  "message": "string"
}

ConflictException schema

{
  "message": "string"
}

ThrottlingException schema

{
  "message": "string"
}

InternalServerException schema

{
  "message": "string"
}

Properties

AccessDeniedException

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

Property	Type	Required	Description
message	string	True

ConflictException

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

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	A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
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. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)

CreateRoutingControlResponse

The result of a successful CreateRoutingControl request.

Property	Type	Required	Description
RoutingControl	RoutingControl	False	The routing control that is created.

InternalServerException

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

Property	Type	Required	Description
message	string	True

ResourceNotFoundException

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

Property	Type	Required	Description
message	string	True

RoutingControl

A routing control has one of two states: ON and OFF. You configure routing controls so they update Amazon Route 53 health checks, which reroute traffic for your application.

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. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)
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

402 response - You attempted to create more resources than the service allows based on service quotas.

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

429 response - LimitExceededException or TooManyRequestsException.

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. The name must be unique within a control panel. You can use any non-white space character in the name except the following: & > < ' (single quote) " (double quote) ; (semicolon)

UpdateRoutingControlResponse

The result of a successful UpdateRoutingControl request.

Property	Type	Required	Description
RoutingControl	RoutingControl	True	The routing control that was updated.

ValidationException

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

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

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

UpdateRoutingControl

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3