control_panels

Creates, updates, deletes, gets or lists a control_panels resource.

Overview

Name	control_panels
Type	Resource
Id	aws.route53_recovery_control_config.control_panels

Fields

The following fields are returned by SELECT queries:

describe_control_panel

Name	Datatype	Description
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster that includes the control panel. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
control_panel_arn	string	The Amazon Resource Name (ARN) of the control panel. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
default_control_panel	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. (pattern: <code>^\S+$</code>)
owner	string	The Amazon Web Services account ID of the control panel owner. (pattern: <code>^\d{12}$</code>)
routing_control_count	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. (PENDING, DEPLOYED, PENDING_DELETION)

list_control_panels

Name	Datatype	Description
cluster_arn	string	The Amazon Resource Name (ARN) of the cluster that includes the control panel. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
control_panel_arn	string	The Amazon Resource Name (ARN) of the control panel. (pattern: <code>^[A-Za-z0-9:/_-]*$</code>)
default_control_panel	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. (pattern: <code>^\S+$</code>)
owner	string	The Amazon Web Services account ID of the control panel owner. (pattern: <code>^\d{12}$</code>)
routing_control_count	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. (PENDING, DEPLOYED, PENDING_DELETION)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_control_panel	select	control_panel_arn, region		Displays details about a control panel.
list_control_panels	select	region	ClusterArn, MaxResults, NextToken	Returns an array of control panels in an account or in a cluster.
create_control_panel	insert	region, ClusterArn, ControlPanelName		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.
update_control_panel	update	region, ControlPanelArn, ControlPanelName		Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.
delete_control_panel	delete	control_panel_arn, region		Deletes a control panel.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
control_panel_arn	string	The Amazon Resource Name (ARN) of the control panel.
region	string	AWS region (default: us-east-1)
ClusterArn	string	The Amazon Resource Name (ARN) of a cluster.
MaxResults	integer	The number of objects that you want to return with this call.
NextToken	string	The token that identifies which batch of results you want to see.

SELECT examples

describe_control_panel

Displays details about a control panel.

SELECT
cluster_arn,
control_panel_arn,
default_control_panel,
name,
owner,
routing_control_count,
status
FROM aws.route53_recovery_control_config.control_panels
WHERE control_panel_arn = '{{ control_panel_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_control_panels

Returns an array of control panels in an account or in a cluster.

SELECT
cluster_arn,
control_panel_arn,
default_control_panel,
name,
owner,
routing_control_count,
status
FROM aws.route53_recovery_control_config.control_panels
WHERE region = '{{ region }}' -- required
AND ClusterArn = '{{ ClusterArn }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_control_panel

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.

INSERT INTO aws.route53_recovery_control_config.control_panels (
ClientToken,
ClusterArn,
ControlPanelName,
Tags,
region
)
SELECT 
'{{ ClientToken }}',
'{{ ClusterArn }}' /* required */,
'{{ ControlPanelName }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
control_panel
;

Manifest

# Description fields are for documentation purposes
- name: control_panels
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the control_panels resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: ClusterArn
    value: "{{ ClusterArn }}"
  - name: ControlPanelName
    value: "{{ ControlPanelName }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_control_panel

Updates a control panel. The only update you can make to a control panel is to change the name of the control panel.

UPDATE aws.route53_recovery_control_config.control_panels
SET 
ControlPanelArn = '{{ ControlPanelArn }}',
ControlPanelName = '{{ ControlPanelName }}'
WHERE 
region = '{{ region }}' --required
AND ControlPanelArn = '{{ ControlPanelArn }}' --required
AND ControlPanelName = '{{ ControlPanelName }}' --required
RETURNING
control_panel;

DELETE examples

delete_control_panel

Deletes a control panel.

DELETE FROM aws.route53_recovery_control_config.control_panels
WHERE control_panel_arn = '{{ control_panel_arn }}' --required
AND region = '{{ region }}' --required
;