Route53RecoveryCluster

Table of Contents

• Route53RecoveryCluster
  • Client
  • Paginators

Client

class Route53RecoveryCluster.Client

A low-level client representing Route53 Recovery Cluster

Welcome to the Amazon Route 53 Application Recovery Controller API Reference Guide for Recovery Control Data Plane .

Recovery control in Route 53 Application Recovery Controller includes extremely reliable routing controls that enable you to recover applications by rerouting traffic, for example, across Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted on a cluster. A cluster is a set of five redundant regional endpoints against which you can execute API calls to update or get the state of routing controls. You use routing controls to failover traffic to recover your application across Availability Zones or Regions.

This API guide includes information about how to get and update routing control states in Route 53 Application Recovery Controller.

For more information about Route 53 Application Recovery Controller, see the following:

• You can create clusters, routing controls, and control panels by using the control plane API for Recovery Control. For more information, see Amazon Route 53 Application Recovery Controller Recovery Control API Reference .
• Route 53 Application Recovery Controller also provides continuous readiness checks to ensure that your applications are scaled to handle failover traffic. For more information about the related API actions, see Amazon Route 53 Application Recovery Controller Recovery Readiness API Reference .
• For more information about creating resilient applications and preparing for recovery readiness with Route 53 Application Recovery Controller, see the Amazon Route 53 Application Recovery Controller Developer Guide .

import boto3

client = boto3.client('route53-recovery-cluster')

These are the available methods:

• can_paginate()
• get_paginator()
• get_routing_control_state()
• get_waiter()
• update_routing_control_state()
• update_routing_control_states()

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").

Returns

True if the operation can be paginated, False otherwise.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters

operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").

Raises OperationNotPageableError

Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.

Return type

L{botocore.paginate.Paginator}

Returns

A paginator object.

get_routing_control_state(**kwargs)

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 the state is On, traffic flows to a cell. When it's off, traffic does not flow.

Before you can create a routing control, you first must create a cluster to host the control. For more information, see CreateCluster . Access one of the endpoints for the cluster to get or update the routing control state to redirect traffic.

For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_routing_control_state(
    RoutingControlArn='string'
)

Parameters

RoutingControlArn (string) --

[REQUIRED]

The Amazon Resource Number (ARN) for the routing control that you want to get the state for.

Return type

dict

Returns

Response Syntax

{
    'RoutingControlArn': 'string',
    'RoutingControlState': 'On'|'Off'
}

Response Structure

• (dict) --
  • RoutingControlArn (string) --

    The Amazon Resource Number (ARN) of the response.

  • RoutingControlState (string) --

    The state of the routing control.

Exceptions

• Route53RecoveryCluster.Client.exceptions.AccessDeniedException
• Route53RecoveryCluster.Client.exceptions.InternalServerException
• Route53RecoveryCluster.Client.exceptions.ResourceNotFoundException
• Route53RecoveryCluster.Client.exceptions.ValidationException
• Route53RecoveryCluster.Client.exceptions.ThrottlingException
• Route53RecoveryCluster.Client.exceptions.EndpointTemporarilyUnavailableException

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters

waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.

Returns

The specified waiter object.

Return type

botocore.waiter.Waiter

update_routing_control_state(**kwargs)

Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.

For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_routing_control_state(
    RoutingControlArn='string',
    RoutingControlState='On'|'Off'
)

Parameters

• RoutingControlArn (string) --

  [REQUIRED]

  The Amazon Resource Number (ARN) for the routing control that you want to update the state for.

• RoutingControlState (string) --

  [REQUIRED]

  The state of the routing control. You can set the value to be On or Off.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• Route53RecoveryCluster.Client.exceptions.AccessDeniedException
• Route53RecoveryCluster.Client.exceptions.InternalServerException
• Route53RecoveryCluster.Client.exceptions.ResourceNotFoundException
• Route53RecoveryCluster.Client.exceptions.ValidationException
• Route53RecoveryCluster.Client.exceptions.ThrottlingException
• Route53RecoveryCluster.Client.exceptions.EndpointTemporarilyUnavailableException
• Route53RecoveryCluster.Client.exceptions.ConflictException

update_routing_control_states(**kwargs)

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.

For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_routing_control_states(
    UpdateRoutingControlStateEntries=[
        {
            'RoutingControlArn': 'string',
            'RoutingControlState': 'On'|'Off'
        },
    ]
)

Parameters

UpdateRoutingControlStateEntries (list) --

[REQUIRED]

A set of routing control entries that you want to update.

• (dict) --

  A routing control state.

  • RoutingControlArn (string) -- [REQUIRED]

    The Amazon Resource Number (ARN) for the routing control state entry.

  • RoutingControlState (string) -- [REQUIRED]

    The routing control state in a set of routing control state entries.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• Route53RecoveryCluster.Client.exceptions.AccessDeniedException
• Route53RecoveryCluster.Client.exceptions.InternalServerException
• Route53RecoveryCluster.Client.exceptions.ResourceNotFoundException
• Route53RecoveryCluster.Client.exceptions.ValidationException
• Route53RecoveryCluster.Client.exceptions.ThrottlingException
• Route53RecoveryCluster.Client.exceptions.EndpointTemporarilyUnavailableException
• Route53RecoveryCluster.Client.exceptions.ConflictException

Paginators

The available paginators are: