route53recoverycluster/aws.sdk.kotlin.services.route53recoverycluster/Route53RecoveryClusterClient

Route53RecoveryClusterClient

interface Route53RecoveryClusterClient : SdkClient

Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.

With Route 53 ARC, you can use routing control with extreme reliability to recover applications by rerouting traffic across Availability Zones or Amazon Web Services Regions. Routing controls are simple on/off switches hosted on a highly available cluster in Route 53 ARC. A cluster provides a set of five redundant Regional endpoints against which you can run API calls to get or update the state of routing controls. To implement failover, you set one routing control to ON and another one to OFF, to reroute traffic from one Availability Zone or Amazon Web Services Region to another.

Be aware that you must specify a Regional endpoint for a cluster when you work with API cluster operations to get or update routing control states in Route 53 ARC. In addition, you must specify the US West (Oregon) Region for Route 53 ARC API calls. For example, use the parameter --region us-west-2 with AWS CLI commands. For more information, see Get and update routing control states using the API in the Amazon Route 53 Application Recovery Controller Developer Guide.

This API guide includes information about the API operations for how to get and update routing control states in Route 53 ARC. To work with routing control in Route 53 ARC, you must first create the required components (clusters, control panels, and routing controls) using the recovery cluster configuration API.

For more information about working with routing control in Route 53 ARC, see the following:

Create clusters, control panels, and routing controls by using API operations. For more information, see the Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller.
Learn about the components in recovery control, including clusters, routing controls, and control panels, and how to work with Route 53 ARC in the Amazon Web Services console. For more information, see Recovery control components in the Amazon Route 53 Application Recovery Controller Developer Guide.
Route 53 ARC also provides readiness checks that continually audit resources to help make sure that your applications are scaled and ready to handle failover traffic. For more information about the related API operations, see the Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller.
For more information about creating resilient applications and preparing for recovery readiness with Route 53 ARC, see the Amazon Route 53 Application Recovery Controller Developer Guide.

Types

Builder

class Builder : AbstractSdkClientBuilder<Route53RecoveryClusterClient.Config, Route53RecoveryClusterClient.Config.Builder, Route53RecoveryClusterClient>

Companion

object Companion : AbstractAwsSdkClientFactory<Route53RecoveryClusterClient.Config, Route53RecoveryClusterClient.Config.Builder, Route53RecoveryClusterClient, Route53RecoveryClusterClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: Route53RecoveryClusterClient.Config

Route53RecoveryClusterClient's configuration

Functions

getRoutingControlState

abstract suspend fun getRoutingControlState(input: GetRoutingControlStateRequest): GetRoutingControlStateResponse

Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When a routing control state is set to ON, traffic flows to a cell. When the state is set to OFF, traffic does not flow.

listRoutingControls

abstract suspend fun listRoutingControls(input: ListRoutingControlsRequest = ListRoutingControlsRequest { }): ListRoutingControlsResponse

List routing control names and Amazon Resource Names (ARNs), as well as the routing control state for each routing control, along with the control panel name and control panel ARN for the routing controls. If you specify a control panel ARN, this call lists the routing controls in the control panel. Otherwise, it lists all the routing controls in the cluster.

updateRoutingControlState

abstract suspend fun updateRoutingControlState(input: UpdateRoutingControlStateRequest): UpdateRoutingControlStateResponse

Set the state of the routing control to reroute traffic. You can set the value to ON or OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not flow.

updateRoutingControlStates

abstract suspend fun updateRoutingControlStates(input: UpdateRoutingControlStatesRequest): UpdateRoutingControlStatesResponse

Set multiple routing control states. You can set the value for each state to be ON or OFF. When the state is ON, traffic flows to a cell. When it's OFF, traffic does not flow.

Inherited functions

expect abstract fun close()

getRoutingControlState

inline suspend fun Route53RecoveryClusterClient.getRoutingControlState(crossinline block: GetRoutingControlStateRequest.Builder.() -> Unit): GetRoutingControlStateResponse

listRoutingControls

inline suspend fun Route53RecoveryClusterClient.listRoutingControls(crossinline block: ListRoutingControlsRequest.Builder.() -> Unit): ListRoutingControlsResponse

listRoutingControlsPaginated

fun Route53RecoveryClusterClient.listRoutingControlsPaginated(initialRequest: ListRoutingControlsRequest = ListRoutingControlsRequest { }): Flow<ListRoutingControlsResponse>

fun Route53RecoveryClusterClient.listRoutingControlsPaginated(block: ListRoutingControlsRequest.Builder.() -> Unit): Flow<ListRoutingControlsResponse>

Paginate over ListRoutingControlsResponse results.

updateRoutingControlState

inline suspend fun Route53RecoveryClusterClient.updateRoutingControlState(crossinline block: UpdateRoutingControlStateRequest.Builder.() -> Unit): UpdateRoutingControlStateResponse

Set the state of the routing control to reroute traffic. You can set the value to ON or OFF. When the state is ON, traffic flows to a cell. When the state is OFF, traffic does not flow.

updateRoutingControlStates

inline suspend fun Route53RecoveryClusterClient.updateRoutingControlStates(crossinline block: UpdateRoutingControlStatesRequest.Builder.() -> Unit): UpdateRoutingControlStatesResponse

Set multiple routing control states. You can set the value for each state to be ON or OFF. When the state is ON, traffic flows to a cell. When it's OFF, traffic does not flow.

withConfig

fun Route53RecoveryClusterClient.withConfig(block: Route53RecoveryClusterClient.Config.Builder.() -> Unit): Route53RecoveryClusterClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.