create_control_panel

create_control_panel(**kwargs)

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 Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

response = client.create_control_panel(
    ClientToken='string',
    ClusterArn='string',
    ControlPanelName='string',
    Tags={
        'string': '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 for the control panel.

• ControlPanelName (string) --

  [REQUIRED]

  The name of the control panel.

• Tags (dict) --

  The tags associated with the control panel.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'ControlPanel': {
        'ClusterArn': 'string',
        'ControlPanelArn': 'string',
        'DefaultControlPanel': True|False,
        'Name': 'string',
        'RoutingControlCount': 123,
        'Status': 'PENDING'|'DEPLOYED'|'PENDING_DELETION'
    }
}

Response Structure

• (dict) --

  200 response - Success.

  • ControlPanel (dict) --

    Information about a control panel.

    • ClusterArn (string) --

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

    • ControlPanelArn (string) --

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

    • DefaultControlPanel (boolean) --

      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) --

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

    • RoutingControlCount (integer) --

      The number of routing controls in the control panel.

    • Status (string) --

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

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