AWS::Route53RecoveryControl::ControlPanel - AWS CloudFormation

AWS::Route53RecoveryControl::ControlPanel

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 AWS Region.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Route53RecoveryControl::ControlPanel", "Properties" : { "ClusterArn" : String, "Name" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::Route53RecoveryControl::ControlPanel Properties: ClusterArn: String Name: String Tags: - Tag

Properties

ClusterArn

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

Required: No

Type: String

Update requires: Replacement

Name

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

Required: Yes

Type: String

Update requires: No interruption

Tags

Not currently supported by AWS CloudFormation.

Required: No

Type: List of Tag

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ControlPanelArn object.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

ControlPanelArn

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

DefaultControlPanel

The boolean flag that is set to true for the default control panel in the cluster.

RoutingControlCount

The number of routing controls in the control panel.

Status

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