Navigation

Table Of Contents

  1. Docs
  2. Available services
  3. Route53RecoveryCluster

Route53RecoveryCluster

Client

class Route53RecoveryCluster.Client

A low-level client representing Route53 Recovery Cluster

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 On and another one 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:

import boto3

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

These are the available methods:

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 a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.

Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.

You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.

To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.

Learn more about working with routing controls in the following topics in the Amazon 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 Name (ARN) for the routing control that you want to get the state for.

Return type
dict
Returns
Response Syntax
{
    'RoutingControlArn': 'string',
    'RoutingControlState': 'On'|'Off',
    'RoutingControlName': 'string'
}

Response Structure

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

      The Amazon Resource Name (ARN) of the response.

    • RoutingControlState (string) --

      The state of the routing control.

    • RoutingControlName (string) --

      The routing control name.

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
list_routing_controls(**kwargs)

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.

A routing control is a simple on/off switch in Route 53 ARC that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.

Before you can create a routing control, you must first create a cluster, and then host the control in a control panel on the cluster. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. You access one of the endpoints for the cluster to get or update the routing control state to redirect traffic for your application.

You must specify Regional endpoints when you work with API cluster operations to use this API operation to list routing controls in Route 53 ARC.

Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:

See also: AWS API Documentation

Request Syntax

response = client.list_routing_controls(
    ControlPanelArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • ControlPanelArn (string) -- The Amazon Resource Name (ARN) of the control panel of the routing controls to list.
  • NextToken (string) -- The token for the next set of results. You receive this token from a previous call.
  • MaxResults (integer) -- The number of routing controls objects that you want to return with this call. The default value is 500.
Return type

dict

Returns

Response Syntax

{
    'RoutingControls': [
        {
            'ControlPanelArn': 'string',
            'ControlPanelName': 'string',
            'RoutingControlArn': 'string',
            'RoutingControlName': 'string',
            'RoutingControlState': 'On'|'Off'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RoutingControls (list) --

      The list of routing controls.

      • (dict) --

        A routing control, which is a simple on/off switch that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.

        • ControlPanelArn (string) --

          The Amazon Resource Name (ARN) of the control panel where the routing control is located.

        • ControlPanelName (string) --

          The name of the control panel where the routing control is located.

        • RoutingControlArn (string) --

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

        • RoutingControlName (string) --

          The name of the routing control.

        • RoutingControlState (string) --

          The current state of the routing control. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.

    • NextToken (string) --

      The token for the next set of results. You receive this token from a previous call.

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
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 the state is Off, traffic does not flow.

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.

The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.

To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon 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',
    SafetyRulesToOverride=[
        'string',
    ]
)
Parameters
  • RoutingControlArn (string) --

    [REQUIRED]

    The Amazon Resource Name (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.

  • SafetyRulesToOverride (list) --

    The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating the state of a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.

    For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

    • (string) --
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.

With Route 53 ARC, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a "break glass" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.

The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Route 53 ARC.

To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon 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'
        },
    ],
    SafetyRulesToOverride=[
        'string',
    ]
)
Parameters
  • UpdateRoutingControlStateEntries (list) --

    [REQUIRED]

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

    • (dict) --

      A routing control state entry.

      • RoutingControlArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) for a routing control state entry.

      • RoutingControlState (string) -- [REQUIRED]

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

  • SafetyRulesToOverride (list) --

    The Amazon Resource Names (ARNs) for the safety rules that you want to override when you're updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.

    For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.

    • (string) --
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
  • Route53RecoveryCluster.Client.exceptions.ServiceLimitExceededException

Paginators

The available paginators are:

class Route53RecoveryCluster.Paginator.ListRoutingControls
paginator = client.get_paginator('list_routing_controls')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Route53RecoveryCluster.Client.list_routing_controls().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ControlPanelArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ControlPanelArn (string) -- The Amazon Resource Name (ARN) of the control panel of the routing controls to list.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'RoutingControls': [
        {
            'ControlPanelArn': 'string',
            'ControlPanelName': 'string',
            'RoutingControlArn': 'string',
            'RoutingControlName': 'string',
            'RoutingControlState': 'On'|'Off'
        },
    ],

}

Response Structure

  • (dict) --

    • RoutingControls (list) --

      The list of routing controls.

      • (dict) --

        A routing control, which is a simple on/off switch that you can use to route traffic to cells. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.

        • ControlPanelArn (string) --

          The Amazon Resource Name (ARN) of the control panel where the routing control is located.

        • ControlPanelName (string) --

          The name of the control panel where the routing control is located.

        • RoutingControlArn (string) --

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

        • RoutingControlName (string) --

          The name of the routing control.

        • RoutingControlState (string) --

          The current state of the routing control. When a routing control state is On, traffic flows to a cell. When the state is Off, traffic does not flow.

Route53
Route53RecoveryControlConfig

Navigation

Privacy | Site Terms | Cookie preferences | © Copyright 2021, Amazon Web Services, Inc. Created using Sphinx.