Route53RecoveryControlConfig / Client / create_routing_control

create_routing_control#

Route53RecoveryControlConfig.Client.create_routing_control(**kwargs)#

Creates a new routing control.

A routing control has one of two states: ON and OFF. You can map the routing control state to the state of an Amazon Route 53 health check, which can be used to control traffic routing.

To get or update the routing control state, see the Recovery Cluster (data plane) API actions for Amazon Route 53 Application Recovery Controller.

See also: AWS API Documentation

Request Syntax

response = client.create_routing_control(
    ClientToken='string',
    ClusterArn='string',
    ControlPanelArn='string',
    RoutingControlName='string'
)
Parameters:

  • ClientToken (string) –

    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.

    This field is autopopulated if not provided.

  • ClusterArn (string) –

    [REQUIRED]

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

  • ControlPanelArn (string) – The Amazon Resource Name (ARN) of the control panel that includes the routing control.

  • RoutingControlName (string) –

    [REQUIRED]

    The name of the routing control.

Return type:

dict

Returns:

Response Syntax

{
    'RoutingControl': {
        'ControlPanelArn': 'string',
        'Name': 'string',
        'RoutingControlArn': 'string',
        'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION',
        'Owner': 'string'
    }
}

Response Structure

  • (dict) –

    200 response - Success.

    • RoutingControl (dict) –

      The routing control that is created.

      • ControlPanelArn (string) –

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

      • Name (string) –

        The name of the routing control.

      • RoutingControlArn (string) –

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

      • Status (string) –

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

      • Owner (string) –

        The Amazon Web Services account ID of the routing control owner.

Exceptions

  • Route53RecoveryControlConfig.Client.exceptions.ValidationException

  • Route53RecoveryControlConfig.Client.exceptions.InternalServerException

  • Route53RecoveryControlConfig.Client.exceptions.ServiceQuotaExceededException

  • Route53RecoveryControlConfig.Client.exceptions.AccessDeniedException

  • Route53RecoveryControlConfig.Client.exceptions.ResourceNotFoundException

  • Route53RecoveryControlConfig.Client.exceptions.ThrottlingException

  • Route53RecoveryControlConfig.Client.exceptions.ConflictException