CreateControlPanel, UpdateControlPanel - Amazon Route 53 Application Recovery Controller

CreateControlPanel, UpdateControlPanel

URI

/controlpanel

HTTP methods

POST

Operation ID: CreateControlPanel

Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or AWS Region.

Responses
Status codeResponse modelDescription
200CreateControlPanelResponse

200 response - Success.

400ValidationException

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.

402ServiceQuotaExceededException

402 response

403AccessDeniedException

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

404ResourceNotFoundException

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

409ConflictException

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

429ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500InternalServerException

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

PUT

Operation ID: UpdateControlPanel

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

Responses
Status codeResponse modelDescription
200UpdateControlPanelResponse

200 response - Success.

400ValidationException

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.

403AccessDeniedException

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

404ResourceNotFoundException

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

409ConflictException

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

429ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

500InternalServerException

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

OPTIONS

Responses
Status codeResponse modelDescription
200None

200 response - Success.

Schemas

Request bodies

{ "ClusterArn": "string", "ClientToken": "string", "ControlPanelName": "string", "Tags": [ { "Value": "string", "Key": "string" } ] }
{ "ControlPanelArn": "string", "ControlPanelName": "string" }

Response bodies

{ "ControlPanel": { "ClusterArn": "string", "Status": enum, "ControlPanelArn": "string", "DefaultControlPanel": boolean, "RoutingControlCount": integer, "Name": "string" } }
{ "ControlPanel": { "ClusterArn": "string", "Status": enum, "ControlPanelArn": "string", "DefaultControlPanel": boolean, "RoutingControlCount": integer, "Name": "string" } }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }

Properties

AccessDeniedException

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

PropertyTypeRequiredDescription
message

string

True

ConflictException

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

PropertyTypeRequiredDescription
message

string

True

ControlPanel

A control panel represents a group of routing controls that can be changed together in a single transaction.

PropertyTypeRequiredDescription
ClusterArn

string

False

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

ControlPanelArn

string

False

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

DefaultControlPanel

boolean

False

A flag that Amazon Route 53 Application Recovery Controller sets to true to designate the default control panel for a cluster. When you create a cluster, Amazon Route 53 Application Recovery Controller creates a control panel, and sets this flag for that control panel. If you create a control panel yourself, this flag is set to false.

Name

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

False

The name of the control panel. You can use any non-white space character in the name.

RoutingControlCount

integer

Format: int32

False

The number of routing controls in the control panel.

Status

Status

False

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

CreateControlPanelRequest

A request to create a control panel.

PropertyTypeRequiredDescription
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 for the control panel.

ControlPanelName

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

True

The name of the control panel.

Tags

Array of type Tag

False

The tags associated with the control panel.

CreateControlPanelResponse

The result of a successful CreateControlPanel request.

PropertyTypeRequiredDescription
ControlPanel

ControlPanel

True

Information about a control panel.

InternalServerException

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

PropertyTypeRequiredDescription
message

string

True

ResourceNotFoundException

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

PropertyTypeRequiredDescription
message

string

True

ServiceQuotaExceededException

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

PropertyTypeRequiredDescription
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

Tag

A tag that you add to a resource.

PropertyTypeRequiredDescription
Key

string

MinLength: 1

MaxLength: 128

True

The key for a tag.

Value

string

MaxLength: 256

True

The value for a tag.

ThrottlingException

429 response - LimitExceededException or TooManyRequestsException.

PropertyTypeRequiredDescription
message

string

True

UpdateControlPanelRequest

Updates an existing control panel.

PropertyTypeRequiredDescription
ControlPanelArn

string

True

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

ControlPanelName

string

Pattern: ^\S+$

MinLength: 1

MaxLength: 64

True

The name of the control panel.

UpdateControlPanelResponse

The result of a successful UpdateControlPanel request.

PropertyTypeRequiredDescription
ControlPanel

ControlPanel

True

The control panel to update.

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.

PropertyTypeRequiredDescription
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:

CreateControlPanel

UpdateControlPanel